Add: Preview support for Articles (#1331)

* Add: Preview support for Article

This adds a fallback to an Article for Microblogging services like Mastodon, because the `summary` is used for content warnings and therefore not reliable enough.

* Added changelog

* Add tests

* update readme

* Update CHANGELOG.md

Co-authored-by: Konstantin Obenland <[email protected]>

* Update changelog

* remove empty line

---------

Co-authored-by: Konstantin Obenland <[email protected]>

Author: pfefferle

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+* A fallback `Note` for `Article` objects to improve previews on services that don't support Articles yet.
 * A reply `context` for Posts and Comments to allow relying parties to discover the whole conversation of a thread.
 * Setting to adjust the number of days Outbox items are kept before being purged.
 * Undo API for Outbox items.

includes/transformer/class-post.php

@@ -1148,4 +1148,20 @@ public function get_shares() {
 			'totalItems' => Interactions::count_by_type( $this->item->ID, 'repost' ),
 		);
 	}
+
+	/**
+	 * Get the preview of the post.
+	 *
+	 * @return array|null The preview of the post or null if the post is not an Article.
+	 */
+	public function get_preview() {
+		if ( 'Article' !== $this->get_type() ) {
+			return null;
+		}
+
+		return array(
+			'type'    => 'Note',
+			'content' => $this->get_summary(),
+		);
+	}
 }

readme.txt

@@ -131,6 +131,7 @@ For reasons of data protection, it is not possible to see the followers of other
 
 = Unreleased =
 
+* Added: A fallback `Note` for `Article` objects to improve previews on services that don't support Articles yet.
 * Added: A reply `context` for Posts and Comments to allow relying parties to discover the whole conversation of a thread.
 * Added: Allow Activities on URLs instead of requiring Activity-Objects. This is useful especially for sending Announces and Likes.
 * Added: Undo API for Outbox items.

tests/includes/transformer/class-test-post.php

@@ -624,4 +624,44 @@ public function create_upload_object( $file, $parent_id = 0 ) {
 
 		return $id;
 	}
+
+	/**
+	 * Test preview property generation.
+	 *
+	 * @covers ::get_preview
+	 */
+	public function test_preview_property() {
+		// Create a test post of type "Article".
+		$post = $this->factory->post->create_and_get(
+			array(
+				'post_title'   => 'Test Article',
+				'post_content' => str_repeat( 'Long content. ', 100 ),
+				'post_status'  => 'publish',
+			)
+		);
+
+		$transformer = new Post( $post );
+		$preview     = $transformer->get_preview();
+
+		// Check if the preview for an Article is correctly generated.
+		$this->assertIsArray( $preview );
+		$this->assertEquals( 'Note', $preview['type'] );
+		$this->assertArrayHasKey( 'content', $preview );
+		$this->assertNotEmpty( $preview['content'] );
+
+		// Create a test post of type "Note" (short content).
+		$note_post = $this->factory->post->create_and_get(
+			array(
+				'post_title'   => '',
+				'post_content' => 'Short note content',
+				'post_status'  => 'publish',
+			)
+		);
+
+		$note_transformer = new Post( $note_post );
+		$note_preview     = $note_transformer->get_preview();
+
+		// Check if the preview for a Note is null.
+		$this->assertNull( $note_preview );
+	}
 }