Merge pull request #2757 from timber/2.x-todo

timber · Jul 21, 2023 · 49e4598 · 49e4598
2 parents a23d781 + 7a71a26
commit 49e4598
Show file tree

Hide file tree

Showing 18 changed files with 61 additions and 249 deletions.
diff --git a/src/Comment.php b/src/Comment.php
@@ -564,7 +564,6 @@ protected function avatar_host($email_hash)
 
     /**
      * @internal
-     * @todo  what if it's relative?
      * @param string $default
      * @param string $email
      * @param string $size

diff --git a/src/CoreEntity.php b/src/CoreEntity.php
@@ -145,7 +145,6 @@ protected function fetch_meta($field_name = '', $args = [], $apply_filters = tru
                 $args
             );
 
-            // @todo Remove when deprecated filters will be gone
             if ($object_type !== 'term') {
                 /**
                  * Filters the value for a post meta field before it is fetched from the database.
@@ -236,7 +235,6 @@ protected function fetch_meta($field_name = '', $args = [], $apply_filters = tru
                 $args
             );
 
-            // @todo Remove when deprecated filters will be gone
             if ($object_type === 'term') {
                 /**
                  * Filters the value for a term meta field.

diff --git a/src/Factory/UserFactory.php b/src/Factory/UserFactory.php
@@ -86,7 +86,6 @@ protected function from_user_object($obj): CoreInterface
         ));
     }
 
-    // @todo return a UserCollection instance?
     protected function from_wp_user_query(WP_User_Query $query): iterable
     {
         return array_map([$this, 'build'], $query->get_results());

diff --git a/src/Loader.php b/src/Loader.php
@@ -198,7 +198,7 @@ public function render($file, $data = null, $expires = false, $cache_mode = self
         /**
          * Filters …
          *
-         * @todo       Add summary
+         * @todo Add summary
          *
          * @deprecated 2.0.0, use `timber/output`
          */
@@ -587,7 +587,6 @@ public function clear_cache_twig()
         $twig = $this->get_twig();
 
         // Get the configured cache location.
-        // @todo What if this is a custom caching implementation?
         $cache_location = $twig->getCache(true);
 
         // Cache not activated.
@@ -596,7 +595,6 @@ public function clear_cache_twig()
         }
 
         if (is_string($cache_location) && is_dir($cache_location)) {
-            // @todo What if not all files could be deleted?
             self::rrmdir($cache_location);
             return true;
         }

diff --git a/src/Post.php b/src/Post.php
@@ -47,7 +47,6 @@
  *     </div>
  * </article>
  * ```
- * @todo implement JsonSerializable?
  */
 class Post extends CoreEntity implements DatedInterface, Setupable
 {
@@ -165,7 +164,7 @@ class Post extends CoreEntity implements DatedInterface, Setupable
     public $slug;
 
     /**
-     * @var string Stores the PostType object for the Post
+     * @var string Stores the PostType object for the post.
      */
     protected $__type;
 

diff --git a/src/PostsIterator.php b/src/PostsIterator.php
@@ -43,7 +43,6 @@ public function current()
         $wp_post = parent::current();
 
         // Lazily instantiate a Timber\Post instance exactly once.
-        // @todo maybe improve performance by caching the instantiated post.
         $post = $factory->from($wp_post);
         $post->setup();
 

diff --git a/src/Timber.php b/src/Timber.php
@@ -195,11 +195,6 @@ public static function handle_preview($data, $post)
             $data['post_title'] = $preview->post_title;
             $data['post_excerpt'] = $preview->post_excerpt;
 
-            // @todo I think we can safely delete this?
-            // It was included in the old PostCollection method but not defined anywhere,
-            // so I think it was always just falling into a magic __call() and doing nothing.
-            // $post->import_custom($preview_id);
-
             add_filter('get_the_terms', '_wp_preview_terms_filter', 10, 3);
         }
 
@@ -318,7 +313,6 @@ public static function get_attachment($query = false, $options = [])
     {
         $post = static::get_post($query, $options);
 
-        // @todo make this determination at the Factory level.
         // No need to instantiate a Post we're not going to use.
         return ($post instanceof Attachment) ? $post : null;
     }
@@ -344,7 +338,6 @@ public static function get_image($query = false, $options = [])
     {
         $post = static::get_post($query, $options);
 
-        // @todo make this determination at the Factory level.
         // No need to instantiate a Post we're not going to use.
         return ($post instanceof Image) ? $post : null;
     }
@@ -457,9 +450,6 @@ public static function get_posts($query = false, $options = [])
             );
         }
 
-        /**
-         * @todo Are there any more default options to support?
-         */
         $options = wp_parse_args($options, [
             'merge_default' => false,
         ]);
@@ -863,7 +853,7 @@ public static function get_term_by(string $field, $value, string $taxonomy = '')
     public static function get_users(array $query = [], array $options = []): iterable
     {
         $factory = new UserFactory();
-        // TODO return a Collection type?
+
         return $factory->from($query);
     }
 
@@ -903,11 +893,6 @@ public static function get_users(array $query = [], array $options = []): iterab
      */
     public static function get_user($user = null)
     {
-        /*
-         * TODO in the interest of time, I'm implementing this logic here. If there's
-         * a better place to do this or something that already implements this, let me know
-         * and I'll switch over to that.
-         */
         $user = $user ?: get_current_user_id();
 
         $factory = new UserFactory();
@@ -1074,7 +1059,7 @@ public static function get_pages_menu(array $args = [])
     public static function get_comments($query = [], array $options = []): iterable
     {
         $factory = new CommentFactory();
-        // TODO return a Collection type?
+
         return $factory->from($query);
     }
 

diff --git a/src/Twig.php b/src/Twig.php
@@ -353,8 +353,6 @@ public function get_timber_filters()
 
             /**
              * Date and Time filters.
-             *
-             * @todo copy this formatting to other functions
              */
             'date' => [
                 'callable' => [$this, 'twig_date_format_filter'],

diff --git a/tests/test-timber-deprecated.php b/tests/test-timber-deprecated.php
diff --git a/tests/test-timber-function-wrapper.php b/tests/test-timber-function-wrapper.php
@@ -57,18 +57,6 @@ public function testFunctionInTemplate()
         $this->assertEquals('bar!', trim($str));
     }
 
-    public function testSoloFunctionUsingWrapper()
-    {
-        if (version_compare(Timber::$version, 2.0, '>=')) {
-            return $this->markTestSkipped(
-                'This functionality is disabled in Timber 2.0'
-            );
-        }
-        new Timber\FunctionWrapper('my_boo');
-        $str = Timber::compile_string("{{ my_boo() }}");
-        $this->assertEquals('bar!', trim($str));
-    }
-
     public function testNakedSoloFunction()
     {
         add_filter('timber/twig', function ($twig) {

diff --git a/tests/test-timber-post-array-object.php b/tests/test-timber-post-array-object.php
@@ -164,14 +164,13 @@ public function testArrayAccess()
             'post_date' => '2020-01-03',
         ]);
 
-        // @todo once the Posts API uses Factories, simplify this to Timber::get_posts([...])
-        $wp_query = new WP_Query('post_type=post');
-
-        $collection = new PostArrayObject($wp_query->posts);
+        $posts = Timber::get_posts([
+            'post_type' => 'post',
+        ]);
 
-        $this->assertEquals('Post 0', $collection[0]->title());
-        $this->assertEquals('Post 1', $collection[1]->title());
-        $this->assertEquals('Post 2', $collection[2]->title());
+        $this->assertEquals('Post 0', $posts[0]->title());
+        $this->assertEquals('Post 1', $posts[1]->title());
+        $this->assertEquals('Post 2', $posts[2]->title());
     }
 
     public function testIterationWithClassMaps()

diff --git a/tests/test-timber-post-collection.php b/tests/test-timber-post-collection.php
@@ -226,8 +226,10 @@ public function testFoundPostsWithPostsPerPage()
     {
         $this->factory->post->create_many(10);
 
-        // @todo once the Posts API uses Factories, simplify this to Timber::get_posts([...])
-        $query = new PostQuery(new WP_Query('post_type=post&posts_per_page=3'));
+        $query = Timber::get_posts([
+            'post_type' => 'post',
+            'posts_per_page' => 3,
+        ]);
 
         $this->assertCount(3, $query);
         $this->assertSame(10, $query->found_posts);
@@ -249,12 +251,13 @@ public function testArrayAccess()
             'post_date' => '2020-01-03',
         ]);
 
-        // @todo once the Posts API uses Factories, simplify this to Timber::get_posts([...])
-        $query = new PostQuery(new WP_Query('post_type=post'));
+        $posts = Timber::get_posts([
+            'post_type' => 'post',
+        ]);
 
-        $this->assertEquals('Post 0', $query[0]->title());
-        $this->assertEquals('Post 1', $query[1]->title());
-        $this->assertEquals('Post 2', $query[2]->title());
+        $this->assertEquals('Post 0', $posts[0]->title());
+        $this->assertEquals('Post 1', $posts[1]->title());
+        $this->assertEquals('Post 2', $posts[2]->title());
     }
 
     public function testIterationWithClassMaps()

diff --git a/tests/test-timber-post-content.php b/tests/test-timber-post-content.php
@@ -171,10 +171,6 @@ public function testPagedContentWithBlocksAndNextPageAtBeginning()
      */
     public function testGutenbergExcerptOption()
     {
-        global $wp_version;
-        if ($wp_version < 5.0) {
-            $this->markTestSkipped('Only applies to Block editor which is avaialble in WP 5.x');
-        }
         $content_1 = '<!-- wp:paragraph -->
 <p>Heres the start to a thing</p>
 <!-- /wp:paragraph -->

diff --git a/tests/test-timber-post.php b/tests/test-timber-post.php
@@ -178,25 +178,20 @@ public function testNextCategory()
 
     public function testNextCustomTax()
     {
-        $v = get_bloginfo('version');
-        if (version_compare($v, '3.8', '<')) {
-            $this->markTestSkipped('Custom taxonomy prev/next not supported until 3.8');
-        } else {
-            register_taxonomy('pizza', 'post');
-            $posts = [];
-            for ($i = 0; $i < 4; $i++) {
-                $j = $i + 1;
-                $posts[] = $this->factory->post->create([
-                    'post_date' => '2014-02-0' . $j . ' 12:00:00',
-                ]);
-            }
-            wp_set_object_terms($posts[0], 'Cheese', 'pizza', false);
-            wp_set_object_terms($posts[2], 'Cheese', 'pizza', false);
-            wp_set_object_terms($posts[3], 'Mushroom', 'pizza', false);
-            $firstPost = Timber::get_post($posts[0]);
-            $nextPost = Timber::get_post($posts[2]);
-            $this->assertEquals($firstPost->next('pizza')->ID, $nextPost->ID);
+        register_taxonomy('pizza', 'post');
+        $posts = [];
+        for ($i = 0; $i < 4; $i++) {
+            $j = $i + 1;
+            $posts[] = $this->factory->post->create([
+                'post_date' => '2014-02-0' . $j . ' 12:00:00',
+            ]);
         }
+        wp_set_object_terms($posts[0], 'Cheese', 'pizza', false);
+        wp_set_object_terms($posts[2], 'Cheese', 'pizza', false);
+        wp_set_object_terms($posts[3], 'Mushroom', 'pizza', false);
+        $firstPost = Timber::get_post($posts[0]);
+        $nextPost = Timber::get_post($posts[2]);
+        $this->assertEquals($firstPost->next('pizza')->ID, $nextPost->ID);
     }
 
     public function testPrev()
@@ -215,25 +210,20 @@ public function testPrev()
 
     public function testPrevCustomTax()
     {
-        $v = get_bloginfo('version');
-        if (version_compare($v, '3.8', '<')) {
-            $this->markTestSkipped('Custom taxonomy prev/next not supported until 3.8');
-        } else {
-            register_taxonomy('pizza', 'post');
-            $posts = [];
-            for ($i = 0; $i < 3; $i++) {
-                $j = $i + 1;
-                $posts[] = $this->factory->post->create([
-                    'post_date' => '2014-02-0' . $j . ' 12:00:00',
-                    'post_title' => "Pizza $j is so good!",
-                ]);
-            }
-            $cat = wp_insert_term('Cheese', 'pizza');
-            self::set_object_terms($posts[0], $cat, 'pizza', false);
-            self::set_object_terms($posts[2], $cat, 'pizza', false);
-            $lastPost = Timber::get_post($posts[2]);
-            $this->assertEquals($posts[0], $lastPost->prev('pizza')->ID);
+        register_taxonomy('pizza', 'post');
+        $posts = [];
+        for ($i = 0; $i < 3; $i++) {
+            $j = $i + 1;
+            $posts[] = $this->factory->post->create([
+                'post_date' => '2014-02-0' . $j . ' 12:00:00',
+                'post_title' => "Pizza $j is so good!",
+            ]);
         }
+        $cat = wp_insert_term('Cheese', 'pizza');
+        self::set_object_terms($posts[0], $cat, 'pizza', false);
+        self::set_object_terms($posts[2], $cat, 'pizza', false);
+        $lastPost = Timber::get_post($posts[2]);
+        $this->assertEquals($posts[0], $lastPost->prev('pizza')->ID);
     }
 
     public function testPrevCategory()

diff --git a/tests/test-timber-properties.php b/tests/test-timber-properties.php
@@ -5,8 +5,6 @@
  * @group comments-api
  * @group called-post-constructor
  * @group called-term-constructor
- * @todo #2094 replace direct Timber\User instantiations
- * @todo #2094 replace direct Timber\Comment instantiations
  */
 class TestTimberProperty extends Timber_UnitTestCase
 {

diff --git a/tests/test-timber-static.php b/tests/test-timber-static.php
@@ -68,20 +68,22 @@ public function testFrontPageAsPage()
 
     public function testStaticPostPage()
     {
-        $this->markTestSkipped('@todo Undefined offset: 0 - do we need merge_default for this?');
         $this->clearPosts();
         $page_id = $this->factory->post->create([
             'post_title' => 'Gobbles',
             'post_type' => 'page',
         ]);
-        update_option('page_for_posts', $page_id);
-        $this->go_to(home_url('/?p=' . $page_id));
-        $children = $this->factory->post->create_many(10, [
+        $posts = $this->factory->post->create_many(10, [
             'post_title' => 'Timmy',
         ]);
+
+        update_option('show_on_front', 'page');
+        update_option('page_for_posts', $page_id);
+        $this->go_to(get_permalink($page_id));
+
         $posts = Timber::get_posts();
-        $first_post = $posts[0];
-        $this->assertEquals('Timmy', $first_post->title());
+
+        $this->assertEquals('Timmy', $posts[0]->title());
     }
 
     public function testOtherPostOnStaticPostPage()