<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][10515] trunk: Sort activity actions when they're added, instead of when they're fetched.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/10515">10515</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/10515","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-02-05 03:37:27 +0000 (Fri, 05 Feb 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Sort activity actions when they're added, instead of when they're fetched.
Sorting activity actions can be an expensive process, so should not be done
any more frequently than necessary. And it's only necessary to sort when a
new action has been added. So instead of sorting in `bp_activity_get_actions()`,
we now do it in `bp_activity_set_action()`.
Props boonebgorges, imath.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6865">#6865</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpactivitybpactivityfunctionsphp">trunk/src/bp-activity/bp-activity-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesactivityfunctionsphp">trunk/tests/phpunit/testcases/activity/functions.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/tests/phpunit/testcases/activity/functions/</li>
<li><a href="#trunktestsphpunittestcasesactivityfunctionsbpActivityGetActionsphp">trunk/tests/phpunit/testcases/activity/functions/bpActivityGetActions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpactivitybpactivityfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-activity/bp-activity-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-activity/bp-activity-functions.php 2016-02-05 02:41:22 UTC (rev 10514)
+++ trunk/src/bp-activity/bp-activity-functions.php 2016-02-05 03:37:27 UTC (rev 10515)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,6 +385,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'position' => $position,
</span><span class="cx" style="display: block; padding: 0 10px"> ), $component_id, $type, $description, $format_callback, $label, $context );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sort the actions of the affected component.
+ $action_array = (array) $bp->activity->actions->{$component_id};
+ $action_array = bp_sort_by_key( $action_array, 'position', 'num' );
+
+ // Restore keys.
+ $bp->activity->actions->{$component_id} = new stdClass;
+ foreach ( $action_array as $key_ordered ) {
+ $bp->activity->actions->{$component_id}->{$key_ordered['key']} = $key_ordered;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -573,18 +583,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Sort the actions by their position within each component.
- foreach ( $bp->activity->actions as $component => $actions ) {
- $actions = (array) $actions;
- $temp = bp_sort_by_key( $actions, 'position', 'num' );
-
- // Restore keys.
- $bp->activity->actions->{$component} = new stdClass;
- foreach ( $temp as $key_ordered ) {
- $bp->activity->actions->{$component}->{$key_ordered['key']} = $key_ordered;
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $bp->activity->actions;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestcasesactivityfunctionsbpActivityGetActionsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/testcases/activity/functions/bpActivityGetActions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/functions/bpActivityGetActions.php (rev 0)
+++ trunk/tests/phpunit/testcases/activity/functions/bpActivityGetActions.php 2016-02-05 03:37:27 UTC (rev 10515)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,214 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * @group activity
+ * @covers ::bp_activity_get_actions
+ */
+class BP_Tests_Activity_Functions_BpActivityGetActions extends BP_UnitTestCase {
+ protected $reset_actions;
+ protected $reset_actions_sorted;
+
+ public function setUp() {
+ $bp = buddypress();
+
+ $this->reset_actions = clone $bp->activity->actions;
+ $bp->activity->actions = new stdClass();
+
+ $this->reset_actions_sorted = ! empty( $bp->activity->actions_sorted );
+ unset( $bp->activity->actions_sorted );
+ }
+
+ public function tearDown() {
+ $bp = buddypress();
+
+ $bp->activity->actions = $this->reset_actions;
+
+ if ( $this->reset_actions_sorted ) {
+ $bp->activity->actions_sorted = true;
+ } else {
+ unset( $bp->activity->actions_sorted );
+ }
+ }
+
+ /**
+ * @group activity_action
+ */
+ public function test_bp_activity_get_actions_should_sort_by_position() {
+ 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();
+
+ _unregister_post_type( 'foo5' );
+ _unregister_post_type( 'foo25' );
+ _unregister_post_type( 'foo50' );
+
+ $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' ) ) );
+ }
+
+ /**
+ * @ticket BP6865
+ */
+ public function test_bp_activity_get_actions_sort() {
+ bp_activity_set_action(
+ 'foo',
+ 'new_foo',
+ 'Did a foo',
+ '',
+ '',
+ array(),
+ 10
+ );
+
+ bp_activity_set_action(
+ 'foo',
+ 'new_bar',
+ 'Did a bar',
+ '',
+ '',
+ array(),
+ 5
+ );
+
+ $actions = bp_activity_get_actions();
+
+ $expected = array(
+ 'new_bar' => 'new_bar',
+ 'new_foo' => 'new_foo',
+ );
+
+ $this->assertSame( $expected, wp_list_pluck( (array) $actions->foo, 'key' ) );
+ }
+
+ /**
+ * @ticket BP6865
+ */
+ public function test_sort_new_post_type_once() {
+ register_post_type( 'foo', array(
+ 'label' => 'foo',
+ 'public' => true,
+ 'supports' => array( 'buddypress-activity' ),
+ 'bp_activity' => array(
+ 'component_id' => 'blogs',
+ 'action_id' => 'new_foo',
+ 'position' => 1,
+ ),
+ ) );
+
+ $actions = bp_activity_get_actions();
+
+ _unregister_post_type( 'foo' );
+
+ $expected = array(
+ 'new_foo' => 'new_foo',
+ 'new_blog_post' => 'new_blog_post',
+ );
+
+ $this->assertSame( $expected, wp_list_pluck( (array) $actions->blogs, 'key' ) );
+ }
+
+ /**
+ * @ticket BP6865
+ */
+ public function test_sort_new_post_type_twice() {
+ $actions = bp_activity_get_actions();
+ $expected = array(
+ 'new_blog_post' => 'new_blog_post',
+ );
+ $this->assertSame( $expected, wp_list_pluck( (array) $actions->blogs, 'key' ) );
+
+ register_post_type( 'foo', array(
+ 'label' => 'foo',
+ 'public' => true,
+ 'supports' => array( 'buddypress-activity' ),
+ 'bp_activity' => array(
+ 'component_id' => 'blogs',
+ 'action_id' => 'new_foo',
+ 'position' => 1,
+ ),
+ ) );
+
+ $actions = bp_activity_get_actions();
+
+ _unregister_post_type( 'foo' );
+
+ $expected = array(
+ 'new_foo' => 'new_foo',
+ 'new_blog_post' => 'new_blog_post',
+ );
+
+ $this->assertSame( $expected, wp_list_pluck( (array) $actions->blogs, 'key' ) );
+ }
+
+ /**
+ * @ticket BP6865
+ */
+ public function test_sort_no_post_type_registered() {
+ bp_activity_set_action(
+ 'foo',
+ 'new_foo',
+ 'Did a foo',
+ '',
+ '',
+ array(),
+ 10
+ );
+
+ bp_activity_set_action(
+ 'foo',
+ 'new_bar',
+ 'Did a bar',
+ '',
+ '',
+ array(),
+ 5
+ );
+
+ remove_post_type_support( 'post', 'buddypress-activity' );
+
+ $actions = bp_activity_get_actions();
+
+ $expected = array(
+ 'new_bar' => 'new_bar',
+ 'new_foo' => 'new_foo',
+ );
+
+ $this->assertSame( $expected, wp_list_pluck( (array) $actions->foo, 'key' ) );
+
+ // Clean up.
+ add_post_type_support( 'post', 'buddypress-activity' );
+ }
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestcasesactivityfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/activity/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/activity/functions.php 2016-02-05 02:41:22 UTC (rev 10514)
+++ trunk/tests/phpunit/testcases/activity/functions.php 2016-02-05 03:37:27 UTC (rev 10515)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -869,57 +869,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bp->activity->track = array();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * @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;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * @group activity_action
</span><span class="cx" style="display: block; padding: 0 10px"> * @group bp_activity_format_activity_action_custom_post_type_post
</span></span></pre>
</div>
</div>
</body>
</html>