Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: adding get date timestamp to post object #1314

Merged
merged 5 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions library/Helper/Post.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@
use Municipio\Integrations\Component\ImageResolver;
use ComponentLibrary\Integrations\Image\Image as ImageComponentContract;
use Municipio\Helper\Term\Term;
use Municipio\PostObject\Date\ArchiveDateSettingResolver;
use Municipio\PostObject\Decorators\BackwardsCompatiblePostObject;
use Municipio\PostObject\Decorators\IconResolvingPostObject;
use Municipio\PostObject\Decorators\PostObjectFromOtherBlog;
use Municipio\PostObject\Decorators\PostObjectFromWpPost;
use Municipio\PostObject\Decorators\PostDateTimestamp;
use Municipio\PostObject\Decorators\PostObjectDateTimestamp;
use Municipio\PostObject\Decorators\PostObjectWithOtherBlogIdFromSwitchedState;
use Municipio\PostObject\Decorators\PostObjectWithSeoRedirect;
use Municipio\PostObject\Icon\Resolvers\CachedIconResolver;
Expand All @@ -20,6 +23,10 @@
use Municipio\PostObject\Icon\Resolvers\TermIconResolver;
use Municipio\PostObject\PostObject;
use Municipio\PostObject\PostObjectInterface;
use Municipio\PostObject\Date\CachedArchiveDateSettingResolver;
use Municipio\PostObject\Date\CachedTimestampResolver;
use Municipio\PostObject\Date\TimestampResolver;
use Municipio\PostObject\Decorators\PostObjectArchiveDateTimestamp;

/**
* Class Post
Expand Down Expand Up @@ -159,6 +166,12 @@ private static function convertWpPostToPostObject(WP_Post $post, string $cacheGr
$postObject = new PostObjectFromWpPost(new PostObject($wpService), $post, $wpService);
$postObject = new PostObjectWithSeoRedirect($postObject, $wpService);

$archiveDateSettingResolver = new ArchiveDateSettingResolver($postObject, $wpService);
$archiveDateSettingResolver = new CachedArchiveDateSettingResolver($postObject, $wpService, $archiveDateSettingResolver);
$timestampResolver = new TimestampResolver($postObject, $wpService, $archiveDateSettingResolver);
$timestampResolver = new CachedTimestampResolver($postObject, $wpService, $timestampResolver);
$postObject = new PostObjectArchiveDateTimestamp($postObject, $wpService, $timestampResolver);

$iconResolver = new TermIconResolver($postObject, $wpService, new Term($wpService, AcfService::get()), new NullIconResolver());
$iconResolver = new PostIconResolver($postObject, $acfService, $iconResolver);
$iconResolver = new CachedIconResolver($postObject, $iconResolver);
Expand Down
29 changes: 29 additions & 0 deletions library/PostObject/Date/ArchiveDateSettingResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use WpService\Contracts\GetThemeMod;

/**
* ArchiveDateSettingResolver class.
*/
class ArchiveDateSettingResolver implements ArchiveDateSettingResolverInterface
{
/**
* Constructor.
*/
public function __construct(
private PostObjectInterface $postObject,
private GetThemeMod $wpService
) {
}

/**
* Resolve the archive date setting.
*/
public function resolve(): string
{
return $this->wpService->getThemeMod('archive_' . $this->postObject->getPostType() . '_date_field', 'post_date');
}
}
40 changes: 40 additions & 0 deletions library/PostObject/Date/ArchiveDateSettingResolver.test.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use PHPUnit\Framework\TestCase;
use WpService\Implementations\FakeWpService;

class ArchiveDateSettingResolverTest extends TestCase
{
/**
* @testdox class can be instantiated
* @runInSeparateProcess
*/
public function testClassCanBeInstantiated()
{
$this->assertInstanceOf(
ArchiveDateSettingResolver::class,
new ArchiveDateSettingResolver($this->createMock(PostObjectInterface::class), new FakeWpService())
);
}

/**
* @testdox resolve() returns archive post date setting
* @runInSeparateProcess
*/
public function testResolveReturnsFoundArchiveSetting()
{
$postObject = $this->createMock(PostObjectInterface::class);
$wpService = new FakeWpService(['getThemeMod' => 'metaKey']);

$resolver = new ArchiveDateSettingResolver($postObject, $wpService);

$result = $resolver->resolve();

$this->assertEquals('metaKey', $result);
}

// TODO: How do i check default value?
}
14 changes: 14 additions & 0 deletions library/PostObject/Date/ArchiveDateSettingResolverInterface.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?php

namespace Municipio\PostObject\Date;

/**
* ArchiveDateSettingResolverInterface interface.
*/
interface ArchiveDateSettingResolverInterface
{
/**
* Resolve the archive date setting.
*/
public function resolve(): string;
}
37 changes: 37 additions & 0 deletions library/PostObject/Date/CachedArchiveDateSettingResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use WpService\Contracts\GetThemeMod;

/**
* CachedArchiveDateSettingResolver class.
*/
class CachedArchiveDateSettingResolver implements ArchiveDateSettingResolverInterface
{
private static array $cache = [];

/**
* Constructor.
*/
public function __construct(
private PostObjectInterface $postObject,
private GetThemeMod $wpService,
private ArchiveDateSettingResolverInterface $innerResolver
) {
}

/**
* Resolve the archive date setting.
*/
public function resolve(): string
{
$cacheKey = "{$this->postObject->getBlogId()}_{$this->postObject->getPostType()}";

if (array_key_exists($cacheKey, self::$cache)) {
return self::$cache[$cacheKey];
}
return self::$cache[$cacheKey] = (string) $this->innerResolver->resolve();
}
}
46 changes: 46 additions & 0 deletions library/PostObject/Date/CachedArchiveDateSettingResolver.test.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use PHPUnit\Framework\TestCase;
use WpService\Implementations\FakeWpService;

class CachedArchiveDateSettingResolverTest extends TestCase
{
/**
* @testdox class can be instantiated
* @runInSeparateProcess
*/
public function testClassCanBeInstantiated()
{
$this->assertInstanceOf(
CachedArchiveDateSettingResolver::class,
new CachedArchiveDateSettingResolver(
$this->createMock(PostObjectInterface::class),
new FakeWpService(),
$this->createMock(ArchiveDateSettingResolverInterface::class)
)
);
}

/**
* @testdox resolve() caches result from inner resolver
* @runInSeparateProcess
*/
public function testResolveCachesResultFromInnerResolver()
{
$postObject = $this->createMock(PostObjectInterface::class);
$postObject->method('getPostType')->willReturn('post_type');
$postObject->method('getBlogId')->willReturn(1);
$innerResolver = $this->createMock(ArchiveDateSettingResolverInterface::class);
$innerResolver->expects($this->exactly(1))->method('resolve')->willReturn('metaKey');

$resolver = new CachedArchiveDateSettingResolver($postObject, new FakeWpService(), $innerResolver);

$result = $resolver->resolve();
$result = $resolver->resolve();

$this->assertEquals('metaKey', $result);
}
}
41 changes: 41 additions & 0 deletions library/PostObject/Date/CachedTimestampResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use WpService\Contracts\GetPostMeta;
use WpService\Contracts\GetThemeMod;

/**
* CachedTimestampResolver class.
*/
class CachedTimestampResolver implements TimestampResolverInterface
{
private static array $idCache = [];

/**
* Constructor.
*/
public function __construct(
private PostObjectInterface $postObject,
private GetThemeMod&GetPostMeta $wpService,
private TimestampResolverInterface $innerResolver
) {
}

/**
* Resolve the timestamp.
*
* @return int
*/
public function resolve(): int
{
$cacheKey = "{$this->postObject->getBlogId()}_{$this->postObject->getId()}";

if (array_key_exists($cacheKey, self::$idCache)) {
return self::$idCache[$cacheKey];
}

return self::$idCache[$cacheKey] = $this->innerResolver->resolve();
}
}
46 changes: 46 additions & 0 deletions library/PostObject/Date/CachedTimestampResolver.test.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use PHPUnit\Framework\TestCase;
use WpService\Implementations\FakeWpService;

class CachedTimestampResolverTest extends TestCase
{
/**
* @testdox class can be instantiated
* @runInSeparateProcess
*/
public function testClassCanBeInstantiated()
{
$this->assertInstanceOf(
CachedTimestampResolver::class,
new CachedTimestampResolver(
$this->createMock(PostObjectInterface::class),
new FakeWpService(),
$this->createMock(TimestampResolverInterface::class)
)
);
}

/**
* @testdox resolve() caches result from inner resolver
* @runInSeparateProcess
*/
public function testResolveCachesResultFromInnerResolver()
{
$postObject = $this->createMock(PostObjectInterface::class);
$postObject->method('getId')->willReturn(1);
$postObject->method('getBlogId')->willReturn(1);
$innerResolver = $this->createMock(TimestampResolverInterface::class);
$innerResolver->expects($this->exactly(1))->method('resolve')->willReturn(123);

$resolver = new CachedTimestampResolver($postObject, new FakeWpService(), $innerResolver);

$result = $resolver->resolve();
$result = $resolver->resolve();

$this->assertEquals(123, $result);
}
}
68 changes: 68 additions & 0 deletions library/PostObject/Date/TimestampResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<?php

namespace Municipio\PostObject\Date;

use Municipio\PostObject\PostObjectInterface;
use WpService\Contracts\GetPostMeta;
use Municipio\PostObject\Date\ArchiveDateSettingResolverInterface;

/**
* TimestampResolver class.
*/
class TimestampResolver implements TimestampResolverInterface
{
private $defaultTimestamps = [
'post_date',
'post_modified'
];

/**
* Constructor.
*/
public function __construct(
private PostObjectInterface $postObject,
private GetPostMeta $wpService,
private ArchiveDateSettingResolverInterface $archiveDateSetting
) {
}

/**
* Resolve the timestamp.
*
* @return int
*/
public function resolve(): int
{
$archiveDateSetting = $this->archiveDateSetting->resolve();

if (in_array($archiveDateSetting, $this->defaultTimestamps)) {
return $this->getDefaultTimestamp($archiveDateSetting);
}

return $this->getDateMetaValue($archiveDateSetting);
}

/**
* Get the date meta value.
*/
private function getDateMetaValue(string $archiveDateSetting): int
{
$metaValue = $this->wpService->getPostMeta($this->postObject->getId(), $archiveDateSetting, true);

if ($metaValue) {
return strtotime($metaValue);
}

return 0;
}

/**
* Get the archive date setting.
*/
private function getDefaultTimestamp(string $archiveDateSetting): int
{
return $archiveDateSetting === 'post_modified' ?
$this->postObject->getModifiedTime() :
$this->postObject->getPublishedTime();
}
}
Loading
Loading