Merge branch 'purge-adjacent-posts'

Author: tangrufus

src/Posts/RelatedUrls/RelatedUrls.php

@@ -18,6 +18,7 @@
 
 namespace TypistTech\Sunny\Posts\RelatedUrls;
 
+use TypistTech\Sunny\Posts\RelatedUrls\Strategies\AdjacentPostUrls;
 use TypistTech\Sunny\Posts\RelatedUrls\Strategies\AuthorUrls;
 use TypistTech\Sunny\Posts\RelatedUrls\Strategies\Culprit;
 use TypistTech\Sunny\Posts\RelatedUrls\Strategies\FeedUrls;
@@ -51,6 +52,7 @@ public function __construct(array $strategies = null)
     {
         $strategies = $strategies ?? [
                 new Culprit,
+                new AdjacentPostUrls,
                 new TermsUrls('category'),
                 new TermsUrls('post_tag'),
                 new AuthorUrls,

src/Posts/RelatedUrls/Strategies/AdjacentPostUrls.php

@@ -0,0 +1,132 @@
+<?php
+/**
+ * Sunny
+ *
+ * Automatically purge CloudFlare cache, including cache everything rules.
+ *
+ * @package   Sunny
+ *
+ * @author    Typist Tech <[email protected]>
+ * @copyright 2017 Typist Tech
+ * @license   GPL-2.0+
+ *
+ * @see       https://www.typist.tech/projects/sunny
+ * @see       https://wordpress.org/plugins/sunny/
+ */
+
+declare(strict_types=1);
+
+namespace TypistTech\Sunny\Posts\RelatedUrls\Strategies;
+
+use WP_Post;
+
+/**
+ * Final class AdjacentPostUrls
+ *
+ * @todo This class needs refactor!
+ * @todo Don't use global objects.
+ * @todo Needs a better way to find next/previous posts.
+ */
+final class AdjacentPostUrls implements StrategyInterface
+{
+    const MAX_TRY = 5;
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getKey(): string
+    {
+        return 'adjacent-post';
+    }
+
+    /**
+     * Get adjacent post urls related to this post.
+     *
+     * @param WP_Post $post The WP_Post object from which relationships are determined.
+     *
+     * @return string[]
+     */
+    public function locate(WP_Post $post): array
+    {
+        $related[] = $this->getPreviousPostLink($post, self::MAX_TRY);
+        $related[] = $this->getNextPostLink($post, self::MAX_TRY);
+
+        return array_values(array_filter($related));
+    }
+
+    /**
+     * Find the previous publicly published post url. Quit when counter reaches zero.
+     *
+     * @param WP_Post $currentPost Current post.
+     * @param int     $counter     Trials left before quit.
+     *
+     * @return string|null
+     */
+    private function getPreviousPostLink(WP_Post $currentPost, int $counter)
+    {
+        global $post;
+
+        if ($counter < 1) {
+            return null;
+        }
+        $counter--;
+
+        // @codingStandardsIgnoreStart
+        $post = $currentPost;
+        $prevPost = get_previous_post();
+        // @codingStandardsIgnoreEnd
+
+        if (! $prevPost instanceof WP_Post) {
+            return null;
+        }
+
+        if ('publish' !== get_post_status($prevPost->ID)) {
+            return $this->getPreviousPostLink($prevPost, $counter);
+        }
+
+        $url = get_permalink($prevPost->ID);
+        if (! is_string($url)) {
+            return null;
+        }
+
+        return $url;
+    }
+
+    /**
+     * Find the previous publicly published post url. Quit when counter reaches zero.
+     *
+     * @param WP_Post $currentPost Current post.
+     * @param int     $counter     Trials left before quit.
+     *
+     * @return string|null
+     */
+    private function getNextPostLink(WP_Post $currentPost, int $counter)
+    {
+        global $post;
+
+        if ($counter < 1) {
+            return null;
+        }
+        $counter--;
+
+        // @codingStandardsIgnoreStart
+        $post = $currentPost;
+        $nextPost = get_next_post();
+        // @codingStandardsIgnoreEnd
+
+        if (! $nextPost instanceof WP_Post) {
+            return null;
+        }
+
+        if ('publish' !== get_post_status($nextPost->ID)) {
+            return $this->getNextPostLink($nextPost, $counter);
+        }
+
+        $url = get_permalink($nextPost->ID);
+        if (! is_string($url)) {
+            return null;
+        }
+
+        return $url;
+    }
+}

tests/_data/dump.sql

@@ -27,7 +27,7 @@
 $I->amOnAdminPage('/options-general.php');
 $I->seeLink('small donation', 'https://www.typist.tech/donate/sunny/');
 
-$I->wantToTest('new donate me notice last enqueue timestamp is set in the last 3 seconds');
+$I->wantToTest('new donate me notice last enqueue timestamp is set in the last 10 seconds');
 $lastEnqueueTimestamp = $I->grabOptionFromDatabase($optionName);
-$I->assertGreaterOrEquals(time() - 3, $lastEnqueueTimestamp->getTimestamp());
+$I->assertGreaterOrEquals(time() - 10, $lastEnqueueTimestamp->getTimestamp());
 $I->assertLessOrEquals(time(), $lastEnqueueTimestamp->getTimestamp());

tests/functional/Ads/DonateMeNoticeShowsUpAfterOneMonthCept.php

@@ -28,7 +28,7 @@
 $I->see("If you're looking for help with development");
 $I->seeLink('contact form', 'https://www.typist.tech/contact/');
 
-$I->wantToTest('new hire me notice last enqueue timestamp is set in the last 3 seconds');
+$I->wantToTest('new hire me notice last enqueue timestamp is set in the last 10 seconds');
 $lastEnqueueTimestamp = $I->grabOptionFromDatabase($optionName);
-$I->assertGreaterOrEquals(time() - 3, $lastEnqueueTimestamp->getTimestamp());
+$I->assertGreaterOrEquals(time() - 10, $lastEnqueueTimestamp->getTimestamp());
 $I->assertLessOrEquals(time(), $lastEnqueueTimestamp->getTimestamp());

tests/functional/Ads/HireMeNoticeShowsUpAfterTwoWeeksCept.php

@@ -27,7 +27,7 @@
 $I->amOnAdminPage('/options-general.php');
 $I->seeLink('leave a review on WordPress.org', 'https://wordpress.org/support/plugin/sunny/reviews/?filter=5#new-post');
 
-$I->wantToTest('new review me notice last enqueue timestamp is set in the last 3 seconds');
+$I->wantToTest('new review me notice last enqueue timestamp is set in the last 10 seconds');
 $lastEnqueueTimestamp = $I->grabOptionFromDatabase($optionName);
-$I->assertGreaterOrEquals(time() - 3, $lastEnqueueTimestamp->getTimestamp());
+$I->assertGreaterOrEquals(time() - 10, $lastEnqueueTimestamp->getTimestamp());
 $I->assertLessOrEquals(time(), $lastEnqueueTimestamp->getTimestamp());

tests/functional/Ads/ReviewMeNoticeShowsUpAfterFifteenDaysCept.php

@@ -5,7 +5,7 @@
 
 modules:
     config:
-       WPLoader:
+        WPLoader:
             wpRootFolder: /Users/me/vagrant-local/www/sunny-tester/htdocs/
             dbHost: vvv.dev
             dbName: sunny-tester

tests/integration.suite.example.yml

@@ -15,6 +15,16 @@ public function testForbidden(RestapiTester $I)
         $I->assertForbiddenGet('/sunny/v2/posts/' . self::POST_ID . '/related-urls');
     }
 
+    public function testGetContainsAdjacentPost(RestapiTester $I)
+    {
+        $this->assertGetContains(
+            $I,
+            'adjacent-post',
+            '/2012/10/02/many-categories/',
+            '/2012/12/02/post-format-video-videopress/'
+        );
+    }
+
     public function testGetContainsAuthor(RestapiTester $I)
     {
         $this->assertGetContains(