<!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>[41334] trunk: WP-API JS Client: Add helpers to get a model or collection by route.</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/41334">41334</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/41334","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-09-04 16:00:28 +0000 (Mon, 04 Sep 2017)</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'>WP-API JS Client: Add helpers to get a model or collection by route.
Add two new helper functions, `wp.api.getModelByRoute` and `wp.api.getCollectionByRoute`. Passed a route, they return the matching model or collection, or `undefined` if none is found.
Also adds tests to verify these functions work as expected.
Props rcutmore.
Fixes <a href="https://core.trac.wordpress.org/ticket/41111">#41111</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpapijs">trunk/src/wp-includes/js/wp-api.js</a></li>
<li><a href="#trunktestsqunitwpincludesjswpapijs">trunk/tests/qunit/wp-includes/js/wp-api.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/wp-api.js 2017-09-04 11:16:18 UTC (rev 41333)
+++ trunk/src/wp-includes/js/wp-api.js 2017-09-04 16:00:28 UTC (rev 41334)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,6 +33,33 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.api.utils = wp.api.utils || {};
</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">+ * Determine model based on API route.
+ *
+ * @param {string} route The API route.
+ *
+ * @return {Backbone Model} The model found at given route. Undefined if not found.
+ */
+ wp.api.getModelByRoute = function( route ) {
+ return _.find( wp.api.models, function( model ) {
+ return model.prototype.route && route === model.prototype.route.index;
+ } );
+ };
+
+ /**
+ * Determine collection based on API route.
+ *
+ * @param {string} route The API route.
+ *
+ * @return {Backbone Model} The collection found at given route. Undefined if not found.
+ */
+ wp.api.getCollectionByRoute = function( route ) {
+ return _.find( wp.api.collections, function( collection ) {
+ return collection.prototype.route && route === collection.prototype.route.index;
+ } );
+ };
+
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * ECMAScript 5 shim, adapted from MDN.
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunktestsqunitwpincludesjswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/wp-includes/js/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/wp-includes/js/wp-api.js 2017-09-04 11:16:18 UTC (rev 41333)
+++ trunk/tests/qunit/wp-includes/js/wp-api.js 2017-09-04 16:00:28 UTC (rev 41334)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -194,6 +194,86 @@
</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">+ // Find models by route.
+ var modelsToFetchByRoute = [
+ 'Category',
+ 'Comment',
+ 'Media',
+ 'Page',
+ 'PageRevision',
+ 'Post',
+ 'PostRevision',
+ 'Status',
+ 'Tag',
+ 'Taxonomy',
+ 'Type',
+ 'User'
+ ];
+
+ _.each( modelsToFetchByRoute, function( model ) {
+ QUnit.test( 'Test fetching ' + model + ' by route.', function( assert ) {
+
+ var done = assert.async();
+
+ assert.expect( 1 );
+
+ wp.api.loadPromise.done( function() {
+
+ var theModel = wp.api.models[ model ];
+ var route = theModel.prototype.route.index;
+
+ assert.equal(
+ wp.api.getModelByRoute( route ),
+ theModel,
+ 'wp.api.models.' + model + ' found at route ' + route
+ );
+
+ // Trigger Qunit async completion.
+ done();
+ } );
+ } );
+ } );
+
+ // Find collections by route.
+ var collectionsToFetchByRoute = [
+ 'Categories',
+ 'Comments',
+ 'Media',
+ 'PageRevisions',
+ 'Pages',
+ 'PostRevisions',
+ 'Posts',
+ 'Statuses',
+ 'Tags',
+ 'Taxonomies',
+ 'Types',
+ 'Users'
+ ];
+
+ _.each( collectionsToFetchByRoute, function( collection ) {
+ QUnit.test( 'Test fetching ' + collection + ' by route.', function( assert ) {
+
+ var done = assert.async();
+
+ assert.expect( 1 );
+
+ wp.api.loadPromise.done( function() {
+
+ var theCollection = wp.api.collections[ collection ];
+ var route = theCollection.prototype.route.index;
+
+ assert.equal(
+ wp.api.getCollectionByRoute( route ),
+ theCollection,
+ 'wp.api.collections.' + collection + ' found at ' + route
+ );
+
+ // Trigger Qunit async completion.
+ done();
+ } );
+ } );
+ } );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Test the jswidget custom namespace and endpoints.
</span><span class="cx" style="display: block; padding: 0 10px"> wp.api.init( {
</span><span class="cx" style="display: block; padding: 0 10px"> 'versionString': 'js-widgets/v1/'
</span></span></pre>
</div>
</div>
</body>
</html>