<!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>[42726] trunk: Community Events Dashboard: Always show a WordCamp if one is coming up</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="https://core.trac.wordpress.org/changeset/42726">42726</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42726","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-02-21 23:00:50 +0000 (Wed, 21 Feb 2018)</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'>Community Events Dashboard: Always show a WordCamp if one is coming up
WordCamps are celebrations of the local WordPress Community and once a local one is scheduled, people in that community should know it is coming. This adjusts the WordPress Events in the dashboard widgets to always display a WordCamp, even if there are multiple Meetups happening first.
Props iandunn, metalandcoffee, warmlaundry, alejandroxlopez, jorbin.
Fixes <a href="https://core.trac.wordpress.org/ticket/41112">#41112</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpcommunityeventsphp">trunk/src/wp-admin/includes/class-wp-community-events.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesCommunityEventsphp">trunk/tests/phpunit/tests/admin/includesCommunityEvents.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpcommunityeventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-community-events.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-community-events.php 2018-02-21 22:30:34 UTC (rev 42725)
+++ trunk/src/wp-admin/includes/class-wp-community-events.php 2018-02-21 23:00:50 UTC (rev 42726)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -416,20 +416,33 @@
</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">- * Discards expired events, and reduces the remaining list.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares the event list for presentation.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Discards expired events, and makes WordCamps "sticky." Attendees need more
+ * advanced notice about WordCamps than they do for meetups, so camps should
+ * appear in the list sooner. If a WordCamp is coming up, the API will "stick"
+ * it in the response, even if it wouldn't otherwise appear. When that happens,
+ * the event will be at the end of the list, and will need to be moved into a
+ * higher position, so that it doesn't get trimmed off.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 4.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.0.0 Stick a WordCamp to the final list.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $response_body The response body which contains the events.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array The response body with events trimmed.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function trim_events( $response_body ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $response_body['events'] ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wordcamps = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $current_timestamp = current_time( 'timestamp' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $response_body['events'] as $key => $event ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Skip WordCamps, because they might be multi-day events.
- if ( 'meetup' !== $event['type'] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Skip WordCamps, because they might be multi-day events.
+ * Save a copy so they can be pinned later.
+ */
+ if ( 'wordcamp' === $event['type'] ) {
+ $wordcamps[] = $event;
</ins><span class="cx" style="display: block; padding: 0 10px"> continue;
</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">@@ -441,6 +454,13 @@
</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"> $response_body['events'] = array_slice( $response_body['events'], 0, 3 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $trimmed_event_types = array_column( $response_body['events'], 'type' );
+
+ // Make sure the soonest upcoming WordCamps is pinned in the list.
+ if ( ! in_array( 'wordcamp', $trimmed_event_types ) && $wordcamps ) {
+ array_pop( $response_body['events'] );
+ array_push( $response_body['events'], $wordcamps[0] );
+ }
</ins><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"> return $response_body;
</span></span></pre></div>
<a id="trunktestsphpunittestsadminincludesCommunityEventsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesCommunityEvents.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesCommunityEvents.php 2018-02-21 22:30:34 UTC (rev 42725)
+++ trunk/tests/phpunit/tests/admin/includesCommunityEvents.php 2018-02-21 23:00:50 UTC (rev 42726)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,6 +259,224 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test: get_events() should return the events with the WordCamp pinned in the prepared list.
+ *
+ * @since 5.0.0
+ */
+ public function test_get_events_pin_wordcamp() {
+ add_filter( 'pre_http_request', array( $this, '_http_request_valid_response_unpinned_wordcamp' ) );
+
+ $response_body = $this->instance->get_events();
+
+ /*
+ * San Diego was at position 3 in the mock API response, but pinning puts it at position 2,
+ * so that it remains in the list. The other events should remain unchanged.
+ */
+ $this->assertCount( 3, $response_body['events'] );
+ $this->assertEquals( $response_body['events'][0]['title'], 'Flexbox + CSS Grid: Magic for Responsive Layouts' );
+ $this->assertEquals( $response_body['events'][1]['title'], 'Part 3- Site Maintenance - Tools to Make It Easy' );
+ $this->assertEquals( $response_body['events'][2]['title'], 'WordCamp San Diego' );
+
+ remove_filter( 'pre_http_request', array( $this, '_http_request_valid_response_unpinned_wordcamp' ) );
+ }
+
+ /**
+ * Simulates a valid HTTP response where a WordCamp needs to be pinned higher than it's default position.
+ *
+ * @since 5.0.0
+ *
+ * @return array A mock HTTP response.
+ */
+ public function _http_request_valid_response_unpinned_wordcamp() {
+ return array(
+ 'headers' => '',
+ 'response' => array( 'code' => 200 ),
+ 'cookies' => '',
+ 'filename' => '',
+ 'body' => wp_json_encode(
+ array(
+ 'location' => $this->get_user_location(),
+ 'events' => array(
+ array(
+ 'type' => 'meetup',
+ 'title' => 'Flexbox + CSS Grid: Magic for Responsive Layouts',
+ 'url' => 'https://www.meetup.com/Eastbay-WordPress-Meetup/events/236031233/',
+ 'meetup' => 'The East Bay WordPress Meetup Group',
+ 'meetup_url' => 'https://www.meetup.com/Eastbay-WordPress-Meetup/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Monday 1pm' ) ),
+ 'location' => array(
+ 'location' => 'Oakland, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.808453,
+ 'longitude' => -122.26593,
+ ),
+ ),
+ array(
+ 'type' => 'meetup',
+ 'title' => 'Part 3- Site Maintenance - Tools to Make It Easy',
+ 'url' => 'https://www.meetup.com/Wordpress-Bay-Area-CA-Foothills/events/237706839/',
+ 'meetup' => 'WordPress Bay Area Foothills Group',
+ 'meetup_url' => 'https://www.meetup.com/Wordpress-Bay-Area-CA-Foothills/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Tuesday 1:30pm' ) ),
+ 'location' => array(
+ 'location' => 'Milpitas, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.432813,
+ 'longitude' => -121.907095,
+ ),
+ ),
+ array(
+ 'type' => 'meetup',
+ 'title' => 'WordPress Q&A',
+ 'url' => 'https://www.meetup.com/sanjosewp/events/245419844/',
+ 'meetup' => 'The San Jose WordPress Meetup',
+ 'meetup_url' => 'https://www.meetup.com/sanjosewp/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Wednesday 5:30pm' ) ),
+ 'location' => array(
+ 'location' => 'Milpitas, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.244194,
+ 'longitude' => -121.889313,
+ ),
+ ),
+ array(
+ 'type' => 'wordcamp',
+ 'title' => 'WordCamp San Diego',
+ 'url' => 'https://2018.sandiego.wordcamp.org',
+ 'meetup' => null,
+ 'meetup_url' => null,
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Thursday 9am' ) ),
+ 'location' => array(
+ 'location' => 'San Diego, CA',
+ 'country' => 'US',
+ 'latitude' => 32.7220419,
+ 'longitude' => -117.1534513,
+ ),
+ ),
+ ),
+ )
+ ),
+ );
+ }
+
+ /**
+ * Test: get_events() shouldn't stick an extra WordCamp when there's already one that naturally
+ * falls into the list.
+ *
+ * @since 5.0.0
+ */
+ public function test_get_events_dont_pin_multiple_wordcamps() {
+ add_filter( 'pre_http_request', array( $this, '_http_request_valid_response_multiple_wordcamps' ) );
+
+ $response_body = $this->instance->get_events();
+
+ /*
+ * The first meetup should be removed because it's expired, while the next 3 events are selected.
+ * WordCamp LA should not be stuck to the list, because San Diego already appears naturally.
+ */
+ $this->assertCount( 3, $response_body['events'] );
+ $this->assertEquals( $response_body['events'][0]['title'], 'WordCamp San Diego' );
+ $this->assertEquals( $response_body['events'][1]['title'], 'Part 3- Site Maintenance - Tools to Make It Easy' );
+ $this->assertEquals( $response_body['events'][2]['title'], 'WordPress Q&A' );
+
+ remove_filter( 'pre_http_request', array( $this, '_http_request_valid_response_multiple_wordcamps' ) );
+ }
+
+ /**
+ * Simulates a valid HTTP response where a WordCamp needs to be pinned higher than it's default position.
+ * no need to pin extra camp b/c one already exists in response
+ *
+ * @since 5.0.0
+ *
+ * @return array A mock HTTP response.
+ */
+ public function _http_request_valid_response_multiple_wordcamps() {
+ return array(
+ 'headers' => '',
+ 'response' => array( 'code' => 200 ),
+ 'cookies' => '',
+ 'filename' => '',
+ 'body' => wp_json_encode(
+ array(
+ 'location' => $this->get_user_location(),
+ 'events' => array(
+ array(
+ 'type' => 'meetup',
+ 'title' => 'Flexbox + CSS Grid: Magic for Responsive Layouts',
+ 'url' => 'https://www.meetup.com/Eastbay-WordPress-Meetup/events/236031233/',
+ 'meetup' => 'The East Bay WordPress Meetup Group',
+ 'meetup_url' => 'https://www.meetup.com/Eastbay-WordPress-Meetup/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( '2 days ago' ) ),
+ 'location' => array(
+ 'location' => 'Oakland, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.808453,
+ 'longitude' => -122.26593,
+ ),
+ ),
+ array(
+ 'type' => 'wordcamp',
+ 'title' => 'WordCamp San Diego',
+ 'url' => 'https://2018.sandiego.wordcamp.org',
+ 'meetup' => null,
+ 'meetup_url' => null,
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Tuesday 9am' ) ),
+ 'location' => array(
+ 'location' => 'San Diego, CA',
+ 'country' => 'US',
+ 'latitude' => 32.7220419,
+ 'longitude' => -117.1534513,
+ ),
+ ),
+ array(
+ 'type' => 'meetup',
+ 'title' => 'Part 3- Site Maintenance - Tools to Make It Easy',
+ 'url' => 'https://www.meetup.com/Wordpress-Bay-Area-CA-Foothills/events/237706839/',
+ 'meetup' => 'WordPress Bay Area Foothills Group',
+ 'meetup_url' => 'https://www.meetup.com/Wordpress-Bay-Area-CA-Foothills/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Wednesday 1:30pm' ) ),
+ 'location' => array(
+ 'location' => 'Milpitas, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.432813,
+ 'longitude' => -121.907095,
+ ),
+ ),
+ array(
+ 'type' => 'meetup',
+ 'title' => 'WordPress Q&A',
+ 'url' => 'https://www.meetup.com/sanjosewp/events/245419844/',
+ 'meetup' => 'The San Jose WordPress Meetup',
+ 'meetup_url' => 'https://www.meetup.com/sanjosewp/',
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Thursday 5:30pm' ) ),
+ 'location' => array(
+ 'location' => 'Milpitas, CA, USA',
+ 'country' => 'us',
+ 'latitude' => 37.244194,
+ 'longitude' => -121.889313,
+ ),
+ ),
+ array(
+ 'type' => 'wordcamp',
+ 'title' => 'WordCamp Los Angeles',
+ 'url' => 'https://2018.la.wordcamp.org',
+ 'meetup' => null,
+ 'meetup_url' => null,
+ 'date' => date( 'Y-m-d H:i:s', strtotime( 'next Friday 9am' ) ),
+ 'location' => array(
+ 'location' => 'Los Angeles, CA',
+ 'country' => 'US',
+ 'latitude' => 34.050888,
+ 'longitude' => -118.285426,
+ ),
+ ),
+ ),
+ )
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test that get_unsafe_client_ip() properly anonymizes all possible address formats
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_unsafe_client_ip_anonymization
</span></span></pre>
</div>
</div>
</body>
</html>