Skip to content

Commit

Permalink
Merge pull request #35872 from nextcloud/feature/noid/psr-clock-inter…
Browse files Browse the repository at this point in the history
…face

feat(appframework): ⌚ Make ITimeFactory extend \PSR\Clock\ClockInterface
  • Loading branch information
nickvergessen authored Mar 6, 2023
2 parents 7df188b + c297f8e commit eddc6f2
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 4 deletions.
26 changes: 25 additions & 1 deletion lib/private/AppFramework/Utility/TimeFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
declare(strict_types=1);

/**
* @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com>
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Bernhard Posselt <dev@bernhard-posselt.com>
Expand Down Expand Up @@ -30,11 +31,23 @@
use OCP\AppFramework\Utility\ITimeFactory;

/**
* Needed to mock calls to time()
* Use this to get a timestamp or DateTime object in code to remain testable
*
* @since 8.0.0
* @since 26.0.0 Extends the \Psr\Clock\ClockInterface interface
* @ref https://www.php-fig.org/psr/psr-20/#21-clockinterface
*/
class TimeFactory implements ITimeFactory {
protected \DateTimeZone $timezone;

public function __construct() {
$this->timezone = new \DateTimeZone('UTC');
}

/**
* @return int the result of a call to time()
* @since 8.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getTime(): int {
return time();
Expand All @@ -45,8 +58,19 @@ public function getTime(): int {
* @param \DateTimeZone $timezone
* @return \DateTime
* @since 15.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime {
return new \DateTime($time, $timezone);
}

public function now(): \DateTimeImmutable {
return new \DateTimeImmutable('now', $this->timezone);
}
public function withTimeZone(\DateTimeZone $timezone): static {
$clone = clone $this;
$clone->timezone = $timezone;

return $clone;
}
}
1 change: 1 addition & 0 deletions lib/private/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -1387,6 +1387,7 @@ public function __construct($webRoot, \OC\Config $config) {
$this->registerDeprecatedAlias('ControllerMethodReflector', \OCP\AppFramework\Utility\IControllerMethodReflector::class);

$this->registerAlias(\OCP\AppFramework\Utility\ITimeFactory::class, \OC\AppFramework\Utility\TimeFactory::class);
$this->registerAlias(\Psr\Clock\ClockInterface::class, \OCP\AppFramework\Utility\ITimeFactory::class);
/** @deprecated 19.0.0 */
$this->registerDeprecatedAlias('TimeFactory', \OCP\AppFramework\Utility\ITimeFactory::class);

Expand Down
22 changes: 19 additions & 3 deletions lib/public/AppFramework/Utility/ITimeFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
declare(strict_types=1);

/**
* @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com>
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Bernhard Posselt <dev@bernhard-posselt.com>
Expand All @@ -26,22 +27,37 @@
*/
namespace OCP\AppFramework\Utility;

use Psr\Clock\ClockInterface;

/**
* Needed to mock calls to time()
* Use this to get a timestamp or DateTime object in code to remain testable
*
* @since 8.0.0
* @since 26.0.0 Extends the \Psr\Clock\ClockInterface interface
* @ref https://www.php-fig.org/psr/psr-20/#21-clockinterface
*/
interface ITimeFactory {

interface ITimeFactory extends ClockInterface {
/**
* @return int the result of a call to time()
* @since 8.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getTime(): int;

/**
* @param string $time
* @param \DateTimeZone $timezone
* @param \DateTimeZone|null $timezone
* @return \DateTime
* @since 15.0.0
* @deprecated 26.0.0 {@see ITimeFactory::now()}
*/
public function getDateTime(string $time = 'now', \DateTimeZone $timezone = null): \DateTime;

/**
* @param \DateTimeZone $timezone
* @return static
* @since 26.0.0
*/
public function withTimeZone(\DateTimeZone $timezone): static;
}
49 changes: 49 additions & 0 deletions tests/lib/AppFramework/Utility/TimeFactoryTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php

declare(strict_types=1);

/**
* @copyright Copyright (c) 2022, Joas Schilling <coding@schilljs.com>
*
* @author Joas Schilling <coding@schilljs.com>
*
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/

namespace Test\AppFramework\Utility;

use OC\AppFramework\Utility\TimeFactory;

class TimeFactoryTest extends \Test\TestCase {
protected TimeFactory $timeFactory;

protected function setUp(): void {
$this->timeFactory = new TimeFactory();
}

public function testNow(): void {
$now = $this->timeFactory->now();
self::assertSame('UTC', $now->getTimezone()->getName());
}

public function testNowWithTimeZone(): void {
$timezone = new \DateTimeZone('Europe/Berlin');
$withTimeZone = $this->timeFactory->withTimeZone($timezone);

$now = $withTimeZone->now();
self::assertSame('Europe/Berlin', $now->getTimezone()->getName());
}
}

0 comments on commit eddc6f2

Please sign in to comment.