<!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>[33345] trunk/src/wp-includes/js/customize-preview-nav-menus.js: Customizer: Nav Menus JS cleanup, first round</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/33345">33345</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/33345","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>wonderboymusic</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-07-21 16:13:36 +0000 (Tue, 21 Jul 2015)</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'>Customizer: Nav Menus JS cleanup, first round
* In `init`, settings should be fresh and set to default values before extending
* When looping via `_.each`, pass `this` as 3rd arg to bind context
* Settings should be encapsulated in the module, instead of being exposed as static class props
* `currentRefreshMenuInstanceDebouncedCalls` should be encapsulated and renamed, instead of being the longest symbol in the entire codebase
See <a href="https://core.trac.wordpress.org/ticket/32911">#32911</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjscustomizepreviewnavmenusjs">trunk/src/wp-includes/js/customize-preview-nav-menus.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjscustomizepreviewnavmenusjs"></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/customize-preview-nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-preview-nav-menus.js 2015-07-21 15:23:45 UTC (rev 33344)
+++ trunk/src/wp-includes/js/customize-preview-nav-menus.js 2015-07-21 16:13:36 UTC (rev 33345)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,21 +2,22 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp.customize.menusPreview = ( function( $, api ) {
</span><span class="cx" style="display: block; padding: 0 10px"> 'use strict';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var self;
-
- self = {
- renderQueryVar: null,
- renderNonceValue: null,
- renderNoncePostKey: null,
- previewCustomizeNonce: null,
- requestUri: '/',
- theme: {
- active: false,
- stylesheet: ''
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var currentRefreshDebounced = {},
+ refreshDebounceDelay = 200,
+ settings = {},
+ defaultSettings = {
+ renderQueryVar: null,
+ renderNonceValue: null,
+ renderNoncePostKey: null,
+ previewCustomizeNonce: null,
+ requestUri: '/',
+ theme: {
+ active: false,
+ stylesheet: ''
+ },
+ navMenuInstanceArgs: {}
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- navMenuInstanceArgs: {},
- refreshDebounceDelay: 200
- };
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ self = {};
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> api.bind( 'preview-ready', function() {
</span><span class="cx" style="display: block; padding: 0 10px"> api.preview.bind( 'active', function() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -30,8 +31,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self.init = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var self = this, initializedSettings = {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ settings = _.extend( {}, defaultSettings );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'undefined' !== typeof _wpCustomizePreviewNavMenusExports ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $.extend( self, _wpCustomizePreviewNavMenusExports );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _.extend( settings, _wpCustomizePreviewNavMenusExports );
</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"> api.each( function( setting, id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,7 +136,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {int} menuId
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenu = function( menuId ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var self = this, assignedLocations = [];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var assignedLocations = [];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> api.each(function( setting, id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var matches = id.match( /^nav_menu_locations\[(.+?)]/ );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,11 +145,11 @@
</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">- _.each( self.navMenuInstanceArgs, function( navMenuArgs, instanceNumber ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _.each( settings.navMenuInstanceArgs, function( navMenuArgs, instanceNumber ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( menuId === navMenuArgs.menu || -1 !== _.indexOf( assignedLocations, navMenuArgs.theme_location ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self.refreshMenuInstanceDebounced( instanceNumber );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ this.refreshMenuInstanceDebounced( instanceNumber );
</ins><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">+ }, this );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -157,12 +159,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenuLocation = function( location ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var foundInstance = false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _.each( self.navMenuInstanceArgs, function( navMenuArgs, instanceNumber ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _.each( settings.navMenuInstanceArgs, function( navMenuArgs, instanceNumber ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( location === navMenuArgs.theme_location ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self.refreshMenuInstanceDebounced( instanceNumber );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ this.refreshMenuInstanceDebounced( instanceNumber );
</ins><span class="cx" style="display: block; padding: 0 10px"> foundInstance = true;
</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">+ }, this );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! foundInstance ) {
</span><span class="cx" style="display: block; padding: 0 10px"> api.preview.send( 'refresh' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -176,10 +178,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenuInstance = function( instanceNumber ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var self = this, data, menuId, customized, container, request, wpNavArgs, instance, containerInstanceClassName;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! self.navMenuInstanceArgs[ instanceNumber ] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! settings.navMenuInstanceArgs[ instanceNumber ] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> throw new Error( 'unknown_instance_number' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- instance = self.navMenuInstanceArgs[ instanceNumber ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ instance = settings.navMenuInstanceArgs[ instanceNumber ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> containerInstanceClassName = 'partial-refreshable-nav-menu-' + String( instanceNumber );
</span><span class="cx" style="display: block; padding: 0 10px"> container = $( '.' + containerInstanceClassName );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -197,13 +199,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> menuId = parseInt( menuId, 10 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> data = {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- nonce: self.previewCustomizeNonce, // for Customize Preview
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ nonce: settings.previewCustomizeNonce, // for Customize Preview
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_customize: 'on'
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! self.theme.active ) {
- data.theme = self.theme.stylesheet;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! settings.theme.active ) {
+ data.theme = settings.theme.stylesheet;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- data[ self.renderQueryVar ] = '1';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ data[ settings.renderQueryVar ] = '1';
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Gather settings to send in partial refresh request.
</span><span class="cx" style="display: block; padding: 0 10px"> customized = {};
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -225,7 +227,7 @@
</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"> data.customized = JSON.stringify( customized );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- data[ self.renderNoncePostKey ] = self.renderNonceValue;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ data[ settings.renderNoncePostKey ] = settings.renderNonceValue;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wpNavArgs = $.extend( {}, instance );
</span><span class="cx" style="display: block; padding: 0 10px"> data.wp_nav_menu_args_hash = wpNavArgs.args_hash;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,7 +238,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> request = wp.ajax.send( null, {
</span><span class="cx" style="display: block; padding: 0 10px"> data: data,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- url: self.requestUri
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ url: settings.requestUri
</ins><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px"> request.done( function( data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // If the menu is now not visible, refresh since the page layout may have changed.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -261,17 +263,15 @@
</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">- self.currentRefreshMenuInstanceDebouncedCalls = {};
-
</del><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenuInstanceDebounced = function( instanceNumber ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( self.currentRefreshMenuInstanceDebouncedCalls[ instanceNumber ] ) {
- clearTimeout( self.currentRefreshMenuInstanceDebouncedCalls[ instanceNumber ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( currentRefreshDebounced[ instanceNumber ] ) {
+ clearTimeout( currentRefreshDebounced[ instanceNumber ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self.currentRefreshMenuInstanceDebouncedCalls[ instanceNumber ] = setTimeout(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ currentRefreshDebounced[ instanceNumber ] = setTimeout(
</ins><span class="cx" style="display: block; padding: 0 10px"> function() {
</span><span class="cx" style="display: block; padding: 0 10px"> self.refreshMenuInstance( instanceNumber );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- self.refreshDebounceDelay
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ refreshDebounceDelay
</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>
</div>
</body>
</html>