Changeset 41334

Timestamp:

09/04/2017 04:00:28 PM (7 years ago)

Author:

adamsilverstein

Message:

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 #41111.

Location:

trunk

Files:

• src/wp-includes/js/wp-api.js (modified) (1 diff)
• tests/qunit/wp-includes/js/wp-api.js (modified) (1 diff)

trunk/src/wp-includes/js/wp-api.js

@@ -32 +32 @@
     wp.api = wp.api || {};
     wp.api.utils = wp.api.utils || {};
+
+    /**
+     * 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;
+        } );
+    };
+
 
     /**

trunk/tests/qunit/wp-includes/js/wp-api.js

@@ -195 +195 @@
     } );
 
+    // 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();
+            } );
+        } );
+    } );
+
     // Test the jswidget custom namespace and endpoints.
     wp.api.init( {