Changeset 9194 for trunk/tests/phpunit/testcases/activity/functions.php

Timestamp:

11/27/2014 05:13:29 PM (10 years ago)

Author:

imath

Message:

Post Type Activity Tracking feature

So far the tracking feature was requiring the Blogs component to be active. In 2.2 we are centralizing the majority of the tracking code into the Activity component. A new set of functions and hooks has been created to catch public post types supporting the feature 'buddypress-activity' and to automatically generate an activity when a new item is publicly published.

It's now possible to add this support to any public post type using one unique line of code, eg: add_post_type_support( 'page', 'buddypress-activity' ). In this case BuddyPress will use generic activity attributes.
Each activity attribute of the supported post type can be customized using a specific function (eg: set custom strings to describe the post type activity action).

When registering a post type in WordPress it's also possible to set the 'buddypress-activity' feature using the support parameter of the second argument of the register_post_type() function. Custom activity action strings can be defined within the labels parameter and activity attributes can be set using the new parameter 'bp_activity'.

When the Blogs component is active, the 'post' post type is automatically supporting the 'buddypress-activity' feature. The conditional logic (eg: blog_public option set to 1 ...) that occurs before a new activity is posted and the comments tracking remain unchanged.

props boonebgorges, DJPaul

Fixes #5669

File:

• trunk/tests/phpunit/testcases/activity/functions.php (modified) (1 diff)

trunk/tests/phpunit/testcases/activity/functions.php

@@ -574 +574 @@
 
         $this->assertSame( $expected, $a_obj->action );
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_activity_format_activity_action_custom_post_type_post
+     * @group activity_tracking
+     */
+    public function test_bp_activity_format_activity_action_custom_post_type_post_nonms() {
+        if ( is_multisite() ) {
+            return;
+        }
+
+        $bp = buddypress();
+
+        register_post_type( 'foo', array(
+            'label'   => 'foo',
+            'public'   => true,
+            'supports' => array( 'buddypress-activity' ),
+        ) );
+
+        // Build the actions to fetch the tracking args
+        bp_activity_get_actions();
+
+        $u = $this->factory->user->create();
+        $p = $this->factory->post->create( array(
+            'post_author' => $u,
+            'post_type'   => 'foo',
+        ) );
+
+        $a = $this->factory->activity->create( array(
+            'component'         => 'activity',
+            'type'              => 'new_foo',
+            'user_id'           => $u,
+            'item_id'           => 1,
+            'secondary_item_id' => $p,
+        ) );
+
+        $a_obj = new BP_Activity_Activity( $a );
+
+        $user_link = bp_core_get_userlink( $u );
+        $blog_url = get_home_url();
+        $post_url = add_query_arg( 'p', $p, trailingslashit( $blog_url ) );
+        $post_link = '<a href="' . $post_url . '">item</a>';
+
+        $expected = sprintf( '%s wrote a new %s', $user_link, $post_link );
+
+        $this->assertSame( $expected, $a_obj->action );
+
+        _unregister_post_type( 'foo' );
+
+        // Reset globals
+        unset( $bp->activity->actions->activity->new_foo );
+        $bp->activity->track = array();
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_activity_format_activity_action_custom_post_type_post_ms
+     * @group activity_tracking
+     */
+    public function test_bp_activity_format_activity_action_custom_post_type_post_ms() {
+        if ( ! is_multisite() ) {
+            return;
+        }
+
+        $bp = buddypress();
+
+        $b = $this->factory->blog->create();
+        $u = $this->factory->user->create();
+
+        switch_to_blog( $b );
+
+        register_post_type( 'foo', array(
+            'label'   => 'foo',
+            'public'   => true,
+            'supports' => array( 'buddypress-activity' ),
+        ) );
+
+        // Build the actions to fetch the tracking args
+        bp_activity_get_actions();
+
+        $p = $this->factory->post->create( array(
+            'post_author' => $u,
+            'post_type'   => 'foo',
+        ) );
+
+        $activity_args = array(
+            'component'         => 'activity',
+            'type'              => 'new_foo',
+            'user_id'           => $u,
+            'item_id'           => $b,
+            'secondary_item_id' => $p,
+        );
+
+        _unregister_post_type( 'foo' );
+        bp_activity_get_actions();
+
+        restore_current_blog();
+
+        $a = $this->factory->activity->create( $activity_args );
+
+        $a_obj = new BP_Activity_Activity( $a );
+
+        $user_link = bp_core_get_userlink( $u );
+        $blog_url = get_blog_option( $a_obj->item_id, 'home' );
+        $post_url = add_query_arg( 'p', $p, trailingslashit( $blog_url ) );
+
+        $post_link = '<a href="' . $post_url . '">item</a>';
+
+        $expected = sprintf( '%s wrote a new %s, on the site %s', $user_link, $post_link, '<a href="' . $blog_url . '">' . get_blog_option( $a_obj->item_id, 'blogname' ) . '</a>' );
+
+        $this->assertSame( $expected, $a_obj->action );
+
+        // Reset globals
+        unset( $bp->activity->actions->activity->new_foo );
+        $bp->activity->track = array();
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_activity_get_actions
+     */
+    public function test_bp_activity_get_actions_should_sort_by_position() {
+        $old_actions = bp_activity_get_actions();
+        buddypress()->activity->actions = new stdClass;
+
+        register_post_type( 'foo5', array(
+            'public'      => true,
+            'supports'    => array( 'buddypress-activity' ),
+            'bp_activity' => array(
+                'component_id' => 'foo',
+                'action_id' => 'foo_bar_5',
+                'position' => 5,
+            ),
+        ) );
+
+        register_post_type( 'foo50', array(
+            'public'      => true,
+            'supports'    => array( 'buddypress-activity' ),
+            'bp_activity' => array(
+                'component_id' => 'foo',
+                'action_id' => 'foo_bar_50',
+                'position' => 50,
+            ),
+        ) );
+
+        register_post_type( 'foo25', array(
+            'public'      => true,
+            'supports'    => array( 'buddypress-activity' ),
+            'bp_activity' => array(
+                'component_id' => 'foo',
+                'action_id' => 'foo_bar_25',
+                'position' => 25,
+            ),
+        ) );
+
+        $actions = bp_activity_get_actions();
+
+        $expected = array(
+            'foo_bar_5',
+            'foo_bar_25',
+            'foo_bar_50',
+        );
+        $foo_actions = (array) $actions->foo;
+        $this->assertEquals( $expected, array_values( wp_list_pluck( $foo_actions, 'key' ) ) );
+
+        buddypress()->activity->actions = $old_actions;
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_activity_format_activity_action_custom_post_type_post
+     */
+    public function test_bp_activity_format_activity_action_custom_string_post_type_post_nonms() {
+        if ( is_multisite() ) {
+            return;
+        }
+
+        $bp = buddypress();
+
+        $labels = array(
+            'name'                 => 'bars',
+            'singular_name'        => 'bar',
+            'bp_activity_new_post' => '%1$s shared a new <a href="%2$s">bar</a>',
+        );
+
+        register_post_type( 'foo', array(
+            'labels'      => $labels,
+            'public'      => true,
+            'supports'    => array( 'buddypress-activity' ),
+            'bp_activity' => array(
+                'action_id' => 'foo_bar',
+            ),
+        ) );
+
+        // Build the actions to fetch the tracking args
+        bp_activity_get_actions();
+
+        $u = $this->factory->user->create();
+        $p = $this->factory->post->create( array(
+            'post_author' => $u,
+            'post_type'   => 'foo',
+        ) );
+
+        $a = $this->factory->activity->create( array(
+            'component'         => 'activity',
+            'type'              => 'foo_bar',
+            'user_id'           => $u,
+            'item_id'           => 1,
+            'secondary_item_id' => $p,
+        ) );
+
+        $a_obj = new BP_Activity_Activity( $a );
+
+        $user_link = bp_core_get_userlink( $u );
+        $blog_url = get_home_url();
+        $post_url = add_query_arg( 'p', $p, trailingslashit( $blog_url ) );
+
+        $expected = sprintf( '%1$s shared a new <a href="%2$s">bar</a>', $user_link, $post_url );
+
+        $this->assertSame( $expected, $a_obj->action );
+
+        _unregister_post_type( 'foo' );
+
+        // Reset globals
+        unset( $bp->activity->actions->activity->foo_bar );
+        $bp->activity->track = array();
+    }
+
+    /**
+     * @group activity_action
+     * @group bp_activity_format_activity_action_custom_post_type_post_ms
+     * @group activity_tracking
+     */
+    public function test_bp_activity_format_activity_action_custom_string_post_type_post_ms() {
+        if ( ! is_multisite() ) {
+            return;
+        }
+
+        $bp = buddypress();
+        $reset = $bp->activity->actions;
+
+        $b = $this->factory->blog->create();
+        $u = $this->factory->user->create();
+
+        switch_to_blog( $b );
+
+        $labels = array(
+            'name'                    => 'bars',
+            'singular_name'           => 'bar',
+            'bp_activity_new_post_ms' => '%1$s shared a new <a href="%2$s">bar</a>, on the site %3$s',
+        );
+
+        register_post_type( 'foo', array(
+            'labels'   => $labels,
+            'public'   => true,
+            'supports' => array( 'buddypress-activity' ),
+        ) );
+
+        // Build the actions to fetch the tracking args
+        bp_activity_get_actions();
+
+        $p = $this->factory->post->create( array(
+            'post_author' => $u,
+            'post_type'   => 'foo',
+        ) );
+
+        $activity_args = array(
+            'component'         => 'activity',
+            'type'              => 'new_foo',
+            'user_id'           => $u,
+            'item_id'           => $b,
+            'secondary_item_id' => $p,
+        );
+
+        _unregister_post_type( 'foo' );
+
+        restore_current_blog();
+
+        $a = $this->factory->activity->create( $activity_args );
+
+        $a_obj = new BP_Activity_Activity( $a );
+
+        $user_link = bp_core_get_userlink( $u );
+        $blog_url = get_blog_option( $a_obj->item_id, 'home' );
+        $post_url = add_query_arg( 'p', $p, trailingslashit( $blog_url ) );
+
+        $expected = sprintf( '%1$s shared a new <a href="%2$s">bar</a>, on the site %3$s', $user_link, $post_url, '<a href="' . $blog_url . '">' . get_blog_option( $a_obj->item_id, 'blogname' ) . '</a>' );
+
+        $this->assertSame( $expected, $a_obj->action );
+
+        // Reset globals
+        unset( $bp->activity->actions->activity->new_foo );
+        $bp->activity->track = array();
+    }
+
+    /**
+     * @group bp_activity_set_post_type_tracking_args
+     * @group activity_tracking
+     */
+    public function test_bp_activity_set_post_type_tracking_args() {
+        $bp = buddypress();
+
+        add_post_type_support( 'page', 'buddypress-activity' );
+
+        bp_activity_set_post_type_tracking_args( 'page', array(
+            'component_id' => $bp->blogs->id,
+            'dummy'        => 'dummy value',
+        ) );
+
+        // Build the actions to fetch the tracking args
+        bp_activity_get_actions();
+
+        $u = $this->factory->user->create();
+
+        $post_id = $this->factory->post->create( array(
+            'post_author' => $u,
+            'post_status' => 'publish',
+            'post_type'   => 'page',
+        ) );
+
+        $a = bp_activity_get( array(
+            'action'            => 'new_page',
+            'item_id'           => get_current_blog_id(),
+            'secondary_item_id' => $post_id,
+        ) );
+
+        $this->assertSame( $bp->blogs->id, $a['activities'][0]->component );
+
+        remove_post_type_support( 'page', 'buddypress-activity' );
+
+        // Reset globals
+        unset( $bp->activity->actions->blogs->new_page );
+        $bp->activity->track = array();
     }