Transformers: Allow setting properties to false. (#1567)

Author: obenland

.github/changelog/1567-from-description

@@ -0,0 +1,4 @@
+Significance: patch
+Type: fixed
+
+Transformers allow settings values to false again, a regression from 5.5.0.

includes/activity/class-generic-object.php

@@ -195,7 +195,7 @@ public static function init_from_array( $data ) {
 	 */
 	public function from_array( $data ) {
 		foreach ( $data as $key => $value ) {
-			if ( $value ) {
+			if ( null !== $value ) {
 				$key = camel_to_snake_case( $key );
 				call_user_func( array( $this, 'set_' . $key ), $value );
 			}

includes/transformer/class-base.php

@@ -90,7 +90,7 @@ protected function transform_object_properties( $activity_object ) {
 			if ( \method_exists( $this, $getter ) ) {
 				$value = \call_user_func( array( $this, $getter ) );
 
-				if ( ! empty( $value ) ) {
+				if ( null !== $value ) {
 					$setter = 'set_' . $var;
 
 					/**

tests/includes/activity/class-test-generic-object.php

@@ -77,9 +77,9 @@ public function test_init_from_array_empty_values() {
 
 		$this->assertEquals( $test_data['id'], $object->get_id() );
 		$this->assertEquals( $test_data['type'], $object->get_type() );
-		$this->assertNull( $object->get_name() );
+		$this->assertEmpty( $object->get_name() );
 		$this->assertNull( $object->get_summary() );
-		$this->assertNull( $object->get_content() );
+		$this->assertFalse( $object->get_content() );
 	}
 
 	/**

tests/includes/collection/class-test-outbox.php

@@ -115,7 +115,7 @@ public function activity_object_provider() {
 				),
 				'Create',
 				1,
-				'{"@context":["https:\/\/www.w3.org\/ns\/activitystreams",{"Hashtag":"as:Hashtag","sensitive":"as:sensitive"}],"actor":"http:\/\/example.org\/?author=1","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=351","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/1","type":"Note","content":"\u003Cp\u003EThis is a note\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EThis is a note\u003C\/p\u003E"},"to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html"}}',
+				'{"@context":["https:\/\/www.w3.org\/ns\/activitystreams",{"Hashtag":"as:Hashtag","sensitive":"as:sensitive"}],"actor":"http:\/\/example.org\/?author=1","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=351","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/1","type":"Note","content":"\u003Cp\u003EThis is a note\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EThis is a note\u003C\/p\u003E"},"tag":[],"to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html"}}',
 			),
 			array(
 				array(
@@ -126,7 +126,7 @@ public function activity_object_provider() {
 				),
 				'Create',
 				2,
-				'{"@context":["https:\/\/www.w3.org\/ns\/activitystreams",{"Hashtag":"as:Hashtag","sensitive":"as:sensitive"}],"actor":"http:\/\/example.org\/?author=0","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=352","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/2","type":"Note","content":"\u003Cp\u003EThis is another note\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EThis is another note\u003C\/p\u003E"},"to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html"}}',
+				'{"@context":["https:\/\/www.w3.org\/ns\/activitystreams",{"Hashtag":"as:Hashtag","sensitive":"as:sensitive"}],"actor":"http:\/\/example.org\/?author=0","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=352","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/2","type":"Note","content":"\u003Cp\u003EThis is another note\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EThis is another note\u003C\/p\u003E"},"tag":[],"to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html"}}',
 			),
 			array(
 				Event::init_from_array(
@@ -163,7 +163,7 @@ public function activity_object_provider() {
 				),
 				'Create',
 				1,
-				'{"@context":["https:\/\/schema.org\/","https:\/\/www.w3.org\/ns\/activitystreams",{"pt":"https:\/\/joinpeertube.org\/ns#","mz":"https:\/\/joinmobilizon.org\/ns#","status":"http:\/\/www.w3.org\/2002\/12\/cal\/ical#status","commentsEnabled":"pt:commentsEnabled","isOnline":"mz:isOnline","timezone":"mz:timezone","participantCount":"mz:participantCount","anonymousParticipationEnabled":"mz:anonymousParticipationEnabled","joinMode":{"@id":"mz:joinMode","@type":"mz:joinModeType"},"externalParticipationUrl":{"@id":"mz:externalParticipationUrl","@type":"schema:URL"},"repliesModerationOption":{"@id":"mz:repliesModerationOption","@type":"@vocab"},"contacts":{"@id":"mz:contacts","@type":"@id"}}],"actor":"http:\/\/example.org\/?author=1","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=353","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/3","type":"Event","content":"\u003Cp\u003EYou should not miss this Event!\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EYou should not miss this Event!\u003C\/p\u003E"},"name":"WP Test Event","nameMap":{"en":"WP Test Event"},"endTime":"2030-02-29T17:00:00+01:00","location":[{"id":"https:\/\/example.com\/place\/1","type":"Place","attributedTo":"https:\/\/wp-test.event-federation.eu\/@test","name":"Fediverse Place","address":{"type":"PostalAddress","addressCountry":"FediCountry","addressLocality":"FediTown","postalCode":"1337","streetAddress":"FediStreet"}},{"type":"VirtualLocation","url":"https:\/\/example.com\/VirtualMeetingRoom"}],"startTime":"2030-02-29T16:00:00+01:00","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html","timezone":"Europe\/Vienna","category":"MOVEMENTS_POLITICS","joinMode":"external"}}',
+				'{"@context":["https:\/\/schema.org\/","https:\/\/www.w3.org\/ns\/activitystreams",{"pt":"https:\/\/joinpeertube.org\/ns#","mz":"https:\/\/joinmobilizon.org\/ns#","status":"http:\/\/www.w3.org\/2002\/12\/cal\/ical#status","commentsEnabled":"pt:commentsEnabled","isOnline":"mz:isOnline","timezone":"mz:timezone","participantCount":"mz:participantCount","anonymousParticipationEnabled":"mz:anonymousParticipationEnabled","joinMode":{"@id":"mz:joinMode","@type":"mz:joinModeType"},"externalParticipationUrl":{"@id":"mz:externalParticipationUrl","@type":"schema:URL"},"repliesModerationOption":{"@id":"mz:repliesModerationOption","@type":"@vocab"},"contacts":{"@id":"mz:contacts","@type":"@id"}}],"actor":"http:\/\/example.org\/?author=1","id":"http:\/\/example.org\/?post_type=ap_outbox\u0026p=353","type":"Create","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"object":{"id":"https:\/\/example.com\/3","type":"Event","content":"\u003Cp\u003EYou should not miss this Event!\u003C\/p\u003E","contentMap":{"en":"\u003Cp\u003EYou should not miss this Event!\u003C\/p\u003E"},"name":"WP Test Event","nameMap":{"en":"WP Test Event"},"endTime":"2030-02-29T17:00:00+01:00","location":[{"id":"https:\/\/example.com\/place\/1","type":"Place","attributedTo":"https:\/\/wp-test.event-federation.eu\/@test","name":"Fediverse Place","address":{"type":"PostalAddress","addressCountry":"FediCountry","addressLocality":"FediTown","postalCode":"1337","streetAddress":"FediStreet"}},{"type":"VirtualLocation","url":"https:\/\/example.com\/VirtualMeetingRoom"}],"startTime":"2030-02-29T16:00:00+01:00","to":["https:\/\/www.w3.org\/ns\/activitystreams#Public"],"mediaType":"text\/html","tag":[],"timezone":"Europe\/Vienna","category":"MOVEMENTS_POLITICS","joinMode":"external"}}',
 			),
 		);
 	}

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

@@ -0,0 +1,73 @@
+<?php
+/**
+ * Test file for Base Transformer.
+ *
+ * @package ActivityPub
+ */
+
+namespace Activitypub\Tests\Transformer;
+
+use Activitypub\Activity\Base_Object;
+use Activitypub\Transformer\Base;
+
+/**
+ * Test class for Base Transformer.
+ *
+ * @coversDefaultClass \Activitypub\Transformer\Base
+ */
+class Test_Base extends \WP_UnitTestCase {
+	/**
+	 * Test that false values are properly set in object properties.
+	 *
+	 * @covers ::transform_object_properties
+	 */
+	public function test_transform_object_properties_with_false_value() {
+		// Create a mock transformer that extends Base and has a method returning false.
+		$mock_transformer = new class('test') extends Base {
+			/**
+			 * Get a property that returns false.
+			 *
+			 * @return bool Always returns false.
+			 */
+			public function get_sensitive() {
+				return false;
+			}
+
+			/**
+			 * Public wrapper to test the protected transform_object_properties method.
+			 *
+			 * @param Base_Object $activity_object The ActivityPub Object.
+			 *
+			 * @return Base_Object|\WP_Error The transformed ActivityPub Object or WP_Error on failure.
+			 */
+			public function test_transform_properties( $activity_object ) {
+				return $this->transform_object_properties( $activity_object );
+			}
+		};
+
+		// Create a test object that has 'sensitive' in its var keys.
+		$test_object = new class() extends Base_Object {
+			/**
+			 * Whether the content is sensitive.
+			 *
+			 * @var bool|null
+			 */
+			protected $sensitive;
+
+			/**
+			 * Override get_object_var_keys to include 'sensitive'.
+			 *
+			 * @return array The keys of the object vars.
+			 */
+			public function get_object_var_keys() {
+				return array( 'sensitive' );
+			}
+		};
+
+		// Transform the object.
+		$transformed_object = $mock_transformer->test_transform_properties( $test_object );
+
+		// Assert that the sensitive property could be set to false.
+		$this->assertFalse( $transformed_object->get_sensitive(), 'The sensitive property should be set to false.' );
+	}
+}