<!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>[41112] trunk: WP-API JS Client: Interpret Settings resource as a model.</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/41112">41112</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/41112","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-07-20 20:25:28 +0000 (Thu, 20 Jul 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: Interpret Settings resource as a model.
The REST API does not provide a mechanism to distinguish between endpoints representing models and those representing collections, so the Backbone client must make that distinction internally. Previously wp-api.js accounted for `/users/me`, but not for `/settings`. This patch updates the logic so that `/settings` is properly registered as a Backbone model.
When calling `wp.api.init`, additional endpoints can be specified to be models using the `modelEndpoints` argument.
Props @adamsilverstein.
Fixes <a href="https://core.trac.wordpress.org/ticket/41056">#41056</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjswpapijs">trunk/src/wp-includes/js/wp-api.js</a></li>
<li><a href="#trunktestsqunitfixtureswpapijs">trunk/tests/qunit/fixtures/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-07-20 14:01:39 UTC (rev 41111)
+++ trunk/src/wp-includes/js/wp-api.js 2017-07-20 20:25:28 UTC (rev 41112)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1112,8 +1112,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'PostsRevisions': 'PostRevisions',
</span><span class="cx" style="display: block; padding: 0 10px"> 'PostsTags': 'PostTags'
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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">+ },
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ modelEndpoints = routeModel.get( 'modelEndpoints' ),
+ modelRegex = new RegExp( '(?:.*[+)]|\/(' + modelEndpoints.join( '|' ) + '))$' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Iterate thru the routes, picking up models and collections to build. Builds two arrays,
</span><span class="cx" style="display: block; padding: 0 10px"> * one for models and one for collections.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1137,8 +1140,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> index !== ( '/' + routeModel.get( 'versionString' ).slice( 0, -1 ) )
</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">- // Single items end with a regex (or the special case 'me').
- if ( /(?:.*[+)]|\/me)$/.test( index ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Single items end with a regex, or a special case word.
+ if ( modelRegex.test( index ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> modelRoutes.push( { index: index, route: route } );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1360,10 +1363,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.api.init = function( args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var endpoint, attributes = {}, deferred, promise;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- args = args || {};
- attributes.apiRoot = args.apiRoot || wpApiSettings.root || '/wp-json';
- attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
- attributes.schema = args.schema || null;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ args = args || {};
+ attributes.apiRoot = args.apiRoot || wpApiSettings.root || '/wp-json';
+ attributes.versionString = args.versionString || wpApiSettings.versionString || 'wp/v2/';
+ attributes.schema = args.schema || null;
+ attributes.modelEndpoints = args.modelEndpoints || [ 'me', 'settings' ];
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! attributes.schema && attributes.apiRoot === wpApiSettings.root && attributes.versionString === wpApiSettings.versionString ) {
</span><span class="cx" style="display: block; padding: 0 10px"> attributes.schema = wpApiSettings.schema;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsqunitfixtureswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/fixtures/wp-api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/fixtures/wp-api.js 2017-07-20 14:01:39 UTC (rev 41111)
+++ trunk/tests/qunit/fixtures/wp-api.js 2017-07-20 20:25:28 UTC (rev 41112)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,7 +24,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-json/wp/v2/taxonomy': mockedApiResponse.TaxonomyModel,
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-json/wp/v2/status': mockedApiResponse.StatusModel,
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp-json/wp/v2/type': mockedApiResponse.TypeModel,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'wp-json/js-widgets/v1/': jsWidgetsEndpointSchema
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-json/js-widgets/v1/': jsWidgetsEndpointSchema,
+ 'wp-json/wp/v2/users/me': mockedApiResponse.me,
+ 'wp-json/wp/v2/settings': mockedApiResponse.settings
</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"> /**
</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-07-20 14:01:39 UTC (rev 41111)
+++ trunk/tests/qunit/wp-includes/js/wp-api.js 2017-07-20 20:25:28 UTC (rev 41112)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -115,7 +115,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'Page',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Post',
</span><span class="cx" style="display: block; padding: 0 10px"> 'Tag',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'User'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'User',
+ 'UsersMe',
+ 'Settings'
</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"> _.each( modelsWithIdsClassNames, function( className ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,12 +132,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> assert.ok( theModel, 'We can instantiate wp.api.models.' + className );
</span><span class="cx" style="display: block; padding: 0 10px"> theModel.fetch().done( function( ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var theModel2 = new wp.api.models[ className ]();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- theModel2.set( 'id', theModel.attributes[0].id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ theModel2.set( 'id', theModel.attributes.id );
</ins><span class="cx" style="display: block; padding: 0 10px"> theModel2.fetch().done( function() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // We were able to retrieve the model.
</span><span class="cx" style="display: block; padding: 0 10px"> assert.equal(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- theModel.attributes[0].id,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ theModel.attributes.id,
</ins><span class="cx" style="display: block; padding: 0 10px"> theModel2.get( 'id' ) ,
</span><span class="cx" style="display: block; padding: 0 10px"> 'We should be able to get a ' + className
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>