<!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>[10548] sites/trunk/api.wordpress.org/public_html/events/1.0: Events: Create permenant function for pinning one-off events.</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 { white-space: pre-line; 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://meta.trac.wordpress.org/changeset/10548">10548</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/10548","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-01-04 23:41:00 +0000 (Mon, 04 Jan 2021)</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'>Events: Create permenant function for pinning one-off events.

This will make tasks like <a href="http://meta.trac.wordpress.org/changeset/10527">r10527</a> easier and quicker in the future.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphpunitphp">sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index-phpunit.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php    2020-12-29 17:58:31 UTC (rev 10547)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php      2021-01-04 23:41:00 UTC (rev 10548)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,33 +235,10 @@
</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">                $events = pin_next_online_wordcamp( $events, $_SERVER['HTTP_USER_AGENT'], time() );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><span class="cx" style="display: block; padding: 0 10px">                 $events = pin_next_workshop_discussion_group( $events, $_SERVER['HTTP_USER_AGENT'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         $events = pin_one_off_events( $events, time() );
</ins><span class="cx" style="display: block; padding: 0 10px">                 $events = remove_duplicate_events( $events );
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                // tmp remove, only here b/c last minute
-               if ( time() < strtotime( 'December 18, 2020' ) ) {
-                       array_unshift( $events, array(
-                               'type'                 => 'wordcamp',
-                               'title'                => 'State of the Word',
-                               'url'                  => 'https://wordpress.org/news/2020/12/state-of-the-word-2020/',
-                               'meetup'               => '',
-                               'meetup_url'           => '',
-                               'date'                 => '2020-12-17 00:00:00',
-                               'end_date'             => '2020-12-17 23:00:00',
-                               'start_unix_timestamp' => 1608195600,
-                               'end_unix_timestamp'   => 1608267600,
-
-                               'location' => array(
-                                       'location'  => 'Online',
-                                       'country'   => 'US',
-                                       'latitude'  => 29.768241024468665,
-                                       'longitude' => -95.36765276500797,
-                               ),
-                       ) );
-               }
-
</del><span class="cx" style="display: block; padding: 0 10px">                 // Internal location data cannot be exposed in the response, see get_location().
</span><span class="cx" style="display: block; padding: 0 10px">                if ( isset( $location['internal'] ) && $location['internal'] ) {
</span><span class="cx" style="display: block; padding: 0 10px">                        // Let the client know that a location was successfully determined based on their IP
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1528,6 +1505,34 @@
</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">+ * Pin one-off events.
+ */
+function pin_one_off_events( $events, $current_time ) {
+       if ( $current_time < strtotime( 'December 18, 2020' ) ) {
+               array_unshift( $events, array(
+                       'type'                 => 'wordcamp',
+                       'title'                => 'State of the Word',
+                       'url'                  => 'https://wordpress.org/news/2020/12/state-of-the-word-2020/',
+                       'meetup'               => '',
+                       'meetup_url'           => '',
+                       'date'                 => '2020-12-17 00:00:00',
+                       'end_date'             => '2020-12-17 23:00:00',
+                       'start_unix_timestamp' => 1608195600,
+                       'end_unix_timestamp'   => 1608267600,
+
+                       'location' => array(
+                               'location'  => 'Online',
+                               'country'   => 'US',
+                               'latitude'  => 29.768241024468665,
+                               'longitude' => -95.36765276500797,
+                       ),
+               ) );
+       }
+
+       return $events;
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px">  * Remove duplicate events, based on the URL.
</span><span class="cx" style="display: block; padding: 0 10px">  *
</span><span class="cx" style="display: block; padding: 0 10px">  * This is needed because sometimes an event gets added from multiple functions; e.g., `get_events()` and also `maybe_add_regional_wordcamps()` and/or `pin_next_online_wordcamp()`.
</span></span></pre></div>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10teststestindexphpunitphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index-phpunit.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index-phpunit.php 2020-12-29 17:58:31 UTC (rev 10547)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index-phpunit.php   2021-01-04 23:41:00 UTC (rev 10548)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,7 +2,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> namespace Dotorg\API\Events\Tests;
</span><span class="cx" style="display: block; padding: 0 10px"> use PHPUnit\Framework\TestCase;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use function Dotorg\API\Events\{ get_events, get_location, build_response, is_client_core };
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use function Dotorg\API\Events\{ get_events, get_location, build_response, is_client_core, pin_one_off_events };
</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">  * @group events
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1050,6 +1050,25 @@
</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">+         * @covers ::pin_one_off_events
+        *
+        * @group unit
+        */
+       function test_pin_one_off_events() {
+               $seed_events = array();
+
+               // Don't forget to update the values here when they're updated in the FUT.
+               $actual_events_before_expiration = pin_one_off_events( $seed_events, strtotime( 'December 17, 2020' ) );
+               $actual_events_after_expiration  = pin_one_off_events( $seed_events, strtotime( 'December 18, 2020' ) );
+
+               $this->assertIsArray( $actual_events_after_expiration );
+               $this->assertEmpty( $actual_events_after_expiration );
+
+               $this->assertIsArray( $actual_events_before_expiration );
+               $this->assertSame( 'State of the Word', $actual_events_before_expiration[0]['title'] );
+       }
+
+       /**
</ins><span class="cx" style="display: block; padding: 0 10px">          * @covers ::is_client_core
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @group unit
</span></span></pre>
</div>
</div>

</body>
</html>