enmi-conf.org: comparison wp/wp-admin/js/revisions.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-admin/js/revisions.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 22	8c2e4d02f4ef

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 	revisions = wp.revisions = { model: {}, view: {}, controller: {} };
 	// Link post revisions data served from the back end.
 	revisions.settings = window._wpRevisionsSettings || {};
-	// For debugging
+	// For debugging.
 	revisions.debug = false;
 	/**
 	 * wp.revisions.log
 	 *
 		if ( window.console && revisions.debug ) {
 			window.console.log.apply( window.console, arguments );
 		}
 	};
-	// Handy functions to help with positioning
+	// Handy functions to help with positioning.
 	$.fn.allOffsets = function() {
 		var offset = this.offset() || {top: 0, left: 0}, win = $(window);
 		return _.extend( offset, {
 			right:  win.width()  - offset.left - this.outerWidth(),
 			bottom: win.height() - offset.top  - this.outerHeight()
 		initialize: function( options ) {
 			this.frame = options.frame;
 			this.revisions = options.revisions;
-			// Listen for changes to the revisions or mode from outside
+			// Listen for changes to the revisions or mode from outside.
 			this.listenTo( this.frame, 'update:revisions', this.receiveRevisions );
 			this.listenTo( this.frame, 'change:compareTwoMode', this.updateMode );
-			// Listen for internal changes
+			// Listen for internal changes.
 			this.on( 'change:from', this.handleLocalChanges );
 			this.on( 'change:to', this.handleLocalChanges );
 			this.on( 'change:compareTwoMode', this.updateSliderSettings );
 			this.on( 'update:revisions', this.updateSliderSettings );
-			// Listen for changes to the hovered revision
+			// Listen for changes to the hovered revision.
 			this.on( 'change:hoveredRevision', this.hoverRevision );
 			this.set({
 				max:   this.revisions.length - 1,
 				compareTwoMode: this.frame.get('compareTwoMode'),
 					values: [
 						this.getSliderValue( 'to', 'from' ),
 						this.getSliderValue( 'from', 'to' )
 					],
 					value: null,
-					range: true // ensures handles cannot cross
+					range: true // Ensures handles cannot cross.
 				});
 			} else {
 				this.set({
 					value: this.getSliderValue( 'to', 'to' ),
 					values: null,
 				});
 			}
 			this.trigger( 'update:slider' );
 		},
-		// Called when a revision is hovered
+		// Called when a revision is hovered.
 		hoverRevision: function( model, value ) {
 			this.trigger( 'hovered:revision', value );
 		},
-		// Called when `compareTwoMode` changes
+		// Called when `compareTwoMode` changes.
 		updateMode: function( model, value ) {
 			this.set({ compareTwoMode: value });
 		},
-		// Called when `from` or `to` changes in the local model
+		// Called when `from` or `to` changes in the local model.
 		handleLocalChanges: function() {
 			this.frame.set({
 				from: this.get('from'),
 				to: this.get('to')
 			});
 		},
-		// Receives revisions changes from outside the model
+		// Receives revisions changes from outside the model.
 		receiveRevisions: function( from, to ) {
-			// Bail if nothing changed
+			// Bail if nothing changed.
 			if ( this.get('from') === from && this.get('to') === to ) {
 				return;
 			}
 			this.set({ from: from, to: to }, { silent: true });
 	revisions.model.Tooltip = Backbone.Model.extend({
 		defaults: {
 			revision: null,
 			offset: {},
-			hovering: false, // Whether the mouse is hovering
+			hovering: false, // Whether the mouse is hovering.
-			scrubbing: false // Whether the mouse is scrubbing
+			scrubbing: false // Whether the mouse is scrubbing.
 		},
 		initialize: function( options ) {
 			this.frame = options.frame;
 			this.revisions = options.revisions;
 			if ( diff ) {
 				deferred.resolveWith( context, [ diff ] );
 			} else {
 				this.trigger( 'ensure:load', ids, from, to, deferred.promise() );
 				_.each( ids, _.bind( function( id ) {
-					// Remove anything that has an ongoing request
+					// Remove anything that has an ongoing request.
 					if ( this.requests[ id ] ) {
 						delete ids[ id ];
 					}
-					// Remove anything we already have
+					// Remove anything we already have.
 					if ( this.get( id ) ) {
 						delete ids[ id ];
 					}
 				}, this ) );
 				if ( ! request ) {
-					// Always include the ID that started this ensure
+					// Always include the ID that started this ensure.
 					ids[ id ] = true;
 					request   = this.load( _.keys( ids ) );
 				}
 				request.done( _.bind( function() {
 			}
 			return deferred.promise();
 		},
-		// Returns an array of proximal diffs
+		// Returns an array of proximal diffs.
 		getClosestUnloaded: function( ids, centerId ) {
 			var self = this;
 			return _.chain([0].concat( ids )).initial().zip( ids ).sortBy( function( pair ) {
 				return Math.abs( centerId - pair[1] );
 			}).map( function( pair ) {
 						deferred.resolve();
 					});
 				}).fail( function() {
 					if ( 1 === num ) { // Already tried 1. This just isn't working. Give up.
 						deferred.reject();
-					} else { // Request fewer diffs this time
+					} else { // Request fewer diffs this time.
 						self._loadAll( allRevisionIds, centerId, Math.ceil( num / 2 ) ).done( function() {
 							deferred.resolve();
 						});
 					}
 				});
 			return deferred;
 		},
 		load: function( comparisons ) {
 			wp.revisions.log( 'load', comparisons );
-			// Our collection should only ever grow, never shrink, so remove: false
+			// Our collection should only ever grow, never shrink, so `remove: false`.
 			return this.fetch({ data: { compare: comparisons }, remove: false }).done( function() {
 				wp.revisions.log( 'load:complete', comparisons );
 			});
 		},
 			} );
 			// Set the initial diffs collection.
 			this.diffs.set( this.get( 'diffData' ) );
-			// Set up internal listeners
+			// Set up internal listeners.
 			this.listenTo( this, 'change:from', this.changeRevisionHandler );
 			this.listenTo( this, 'change:to', this.changeRevisionHandler );
 			this.listenTo( this, 'change:compareTwoMode', this.changeMode );
 			this.listenTo( this, 'update:revisions', this.updatedRevisions );
 			this.listenTo( this.diffs, 'ensure:load', this.updateLoadingStatus );
 				to : this.revisions.get( state.to ),
 				from : this.revisions.get( state.from ),
 				compareTwoMode : state.compareTwoMode
 			} );
-			// Start the router if browser supports History API
+			// Start the router if browser supports History API.
 			if ( window.history && window.history.pushState ) {
 				this.router = new revisions.Router({ model: this });
 				if ( Backbone.History.started ) {
 					Backbone.history.stop();
 				}
 		changeMode: function( model, value ) {
 			var toIndex = this.revisions.indexOf( this.get( 'to' ) );
 			// If we were on the first revision before switching to two-handled mode,
-			// bump the 'to' position over one
+			// bump the 'to' position over one.
 			if ( value && 0 === toIndex ) {
 				this.set({
 					from: this.revisions.at( toIndex ),
 					to:   this.revisions.at( toIndex + 1 )
 				});
 			}
 			// When switching back to single-handled mode, reset 'from' model to
-			// one position before the 'to' model
+			// one position before the 'to' model.
-			if ( ! value && 0 !== toIndex ) { // '! value' means switching to single-handled mode
+			if ( ! value && 0 !== toIndex ) { // '! value' means switching to single-handled mode.
 				this.set({
 					from: this.revisions.at( toIndex - 1 ),
 					to:   this.revisions.at( toIndex )
 				});
 			}
 		},
 		updatedRevisions: function( from, to ) {
 			if ( this.get( 'compareTwoMode' ) ) {
-				// TODO: compare-two loading strategy
+				// @todo Compare-two loading strategy.
 			} else {
 				this.diffs.loadAll( this.revisions.pluck('id'), to.id, 40 );
 			}
 		},
 		// Fetch the currently loaded diff.
 		diff: function() {
 			return this.diffs.get( this._diffId );
 		},
-		// So long as `from` and `to` are changed at the same time, the diff
+		/*
-		// will only be updated once. This is because Backbone updates all of
+		 * So long as `from` and `to` are changed at the same time, the diff
-		// the changed attributes in `set`, and then fires the `change` events.
+		 * will only be updated once. This is because Backbone updates all of
+		 * the changed attributes in `set`, and then fires the `change` events.
+		 */
 		updateDiff: function( options ) {
 			var from, to, diffId, diff;
 			options = options || {};
 			from = this.get('from');
 			if ( _.isUndefined( diff ) || _.isUndefined( diff.id ) ) {
 				this.set({
 					loading: false,
 					error: true
 				});
-			} else if ( this._diffId === diff.id ) { // Make sure the current diff didn't change
+			} else if ( this._diffId === diff.id ) { // Make sure the current diff didn't change.
 				this.trigger( 'update:diff', diff );
 			}
 		},
 		_ensureDiff: function() {
 		className: 'revisions-controls',
 		initialize: function() {
 			_.bindAll( this, 'setWidth' );
-			// Add the button view
+			// Add the button view.
 			this.views.add( new revisions.view.Buttons({
 				model: this.model
 			}) );
-			// Add the checkbox view
+			// Add the checkbox view.
 			this.views.add( new revisions.view.Checkbox({
 				model: this.model
 			}) );
-			// Prep the slider model
+			// Prep the slider model.
 			var slider = new revisions.model.Slider({
 				frame: this.model,
 				revisions: this.model.revisions
 			}),
-			// Prep the tooltip model
+			// Prep the tooltip model.
 			tooltip = new revisions.model.Tooltip({
 				frame: this.model,
 				revisions: this.model.revisions,
 				slider: slider
 			});
-			// Add the tooltip view
+			// Add the tooltip view.
 			this.views.add( new revisions.view.Tooltip({
 				model: tooltip
 			}) );
-			// Add the tickmarks view
+			// Add the tickmarks view.
 			this.views.add( new revisions.view.Tickmarks({
 				model: tooltip
 			}) );
-			// Add the slider view
+			// Add the slider view.
 			this.views.add( new revisions.view.Slider({
 				model: slider
 			}) );
-			// Add the Metabox view
+			// Add the Metabox view.
 			this.views.add( new revisions.view.Metabox({
 				model: this.model
 			}) );
 		},
 		setWidth: function() {
 			this.$el.css('width', this.$el.parent().width() + 'px');
 		}
 	});
-	// The tickmarks view
+	// The tickmarks view.
 	revisions.view.Tickmarks = wp.Backbone.View.extend({
 		className: 'revisions-tickmarks',
 		direction: isRtl ? 'right' : 'left',
 		initialize: function() {
 		reportTickPosition: function( model, revision ) {
 			var offset, thisOffset, parentOffset, tick, index = this.model.revisions.indexOf( revision );
 			thisOffset = this.$el.allOffsets();
 			parentOffset = this.$el.parent().allOffsets();
 			if ( index === this.model.revisions.length - 1 ) {
-				// Last one
+				// Last one.
 				offset = {
 					rightPlusWidth: thisOffset.left - parentOffset.left + 1,
 					leftPlusWidth: thisOffset.right - parentOffset.right + 1
 				};
 			} else {
-				// Normal tick
+				// Normal tick.
 				tick = this.$('div:nth-of-type(' + (index + 1) + ')');
 				offset = tick.allPositions();
 				_.extend( offset, {
 					left: offset.left + thisOffset.left - parentOffset.left,
 					right: offset.right + thisOffset.right - parentOffset.right
 				this.$el.append( '<div style="' + this.direction + ': ' + ( 100 * tickWidth * index ) + '%"></div>' );
 			}, this );
 		}
 	});
-	// The metabox view
+	// The metabox view.
 	revisions.view.Metabox = wp.Backbone.View.extend({
 		className: 'revisions-meta',
 		initialize: function() {
-			// Add the 'from' view
+			// Add the 'from' view.
 			this.views.add( new revisions.view.MetaFrom({
 				model: this.model,
 				className: 'diff-meta diff-meta-from'
 			}) );
-			// Add the 'to' view
+			// Add the 'to' view.
 			this.views.add( new revisions.view.MetaTo({
 				model: this.model
 			}) );
 		}
 	});
-	// The revision meta view (to be extended)
+	// The revision meta view (to be extended).
 	revisions.view.Meta = wp.Backbone.View.extend({
 		template: wp.template('revisions-meta'),
 		events: {
 			'click .restore-revision': 'restoreRevision'
 		restoreRevision: function() {
 			document.location = this.model.get('to').attributes.restoreUrl;
 		}
 	});
-	// The revision meta 'from' view
+	// The revision meta 'from' view.
 	revisions.view.MetaFrom = revisions.view.Meta.extend({
 		className: 'diff-meta diff-meta-from',
 		type: 'from'
 	});
-	// The revision meta 'to' view
+	// The revision meta 'to' view.
 	revisions.view.MetaTo = revisions.view.Meta.extend({
 		className: 'diff-meta diff-meta-to',
 		type: 'to'
 	});
 		ready: function() {
 			this.disabledButtonCheck();
 		},
-		// Go to a specific model index
+		// Go to a specific model index.
 		gotoModel: function( toIndex ) {
 			var attributes = {
 				to: this.model.revisions.at( toIndex )
 			};
 			// If we're at the first revision, unset 'from'.
 			}
 			this.model.set( attributes );
 		},
-		// Go to the 'next' revision
+		// Go to the 'next' revision.
 		nextRevision: function() {
 			var toIndex = this.model.revisions.indexOf( this.model.get('to') ) + 1;
 			this.gotoModel( toIndex );
 		},
-		// Go to the 'previous' revision
+		// Go to the 'previous' revision.
 		previousRevision: function() {
 			var toIndex = this.model.revisions.indexOf( this.model.get('to') ) - 1;
 			this.gotoModel( toIndex );
 		},
 			this.applySliderSettings();
 		},
 		mouseMove: function( e ) {
-			var zoneCount         = this.model.revisions.length - 1, // One fewer zone than models
+			var zoneCount         = this.model.revisions.length - 1,       // One fewer zone than models.
-				sliderFrom        = this.$el.allOffsets()[this.direction], // "From" edge of slider
+				sliderFrom        = this.$el.allOffsets()[this.direction], // "From" edge of slider.
-				sliderWidth       = this.$el.width(), // Width of slider
+				sliderWidth       = this.$el.width(),                      // Width of slider.
-				tickWidth         = sliderWidth / zoneCount, // Calculated width of zone
+				tickWidth         = sliderWidth / zoneCount,               // Calculated width of zone.
-				actualX           = ( isRtl ? $(window).width() - e.pageX : e.pageX ) - sliderFrom, // Flipped for RTL - sliderFrom;
+				actualX           = ( isRtl ? $(window).width() - e.pageX : e.pageX ) - sliderFrom, // Flipped for RTL - sliderFrom.
-				currentModelIndex = Math.floor( ( actualX  + ( tickWidth / 2 )  ) / tickWidth ); // Calculate the model index
+				currentModelIndex = Math.floor( ( actualX  + ( tickWidth / 2 )  ) / tickWidth );    // Calculate the model index.
 			// Ensure sane value for currentModelIndex.
 			if ( currentModelIndex < 0 ) {
 				currentModelIndex = 0;
 			} else if ( currentModelIndex >= this.model.revisions.length ) {
 				currentModelIndex = this.model.revisions.length - 1;
 			}
-			// Update the tooltip mode
+			// Update the tooltip mode.
 			this.model.set({ hoveredRevision: this.model.revisions.at( currentModelIndex ) });
 		},
 		mouseLeave: function() {
 			this.model.set({ hovering: false });
 		applySliderSettings: function() {
 			this.$el.slider( _.pick( this.model.toJSON(), 'value', 'values', 'range' ) );
 			var handles = this.$('a.ui-slider-handle');
 			if ( this.model.get('compareTwoMode') ) {
-				// in RTL mode the 'left handle' is the second in the slider, 'right' is first
+				// In RTL mode the 'left handle' is the second in the slider, 'right' is first.
 				handles.first()
 					.toggleClass( 'to-handle', !! isRtl )
 					.toggleClass( 'from-handle', ! isRtl );
 				handles.last()
 					.toggleClass( 'from-handle', !! isRtl )
 				// In two handle mode, ensure handles can't be dragged past each other.
 				// Adjust left/right boundaries and reset points.
 				if ( view.model.get('compareTwoMode') ) {
 					handles = handle.parent().find('.ui-slider-handle');
-					if ( handle.is( handles.first() ) ) { // We're the left handle
+					if ( handle.is( handles.first() ) ) {
+						// We're the left handle.
 						rightDragBoundary = handles.last().offset().left;
 						rightDragReset    = rightDragBoundary - sliderOffset;
-					} else { // We're the right handle
+					} else {
+						// We're the right handle.
 						leftDragBoundary = handles.first().offset().left + handles.first().width();
 						leftDragReset    = leftDragBoundary - sliderOffset;
 					}
 				}
 		getPosition: function( position ) {
 			return isRtl ? this.model.revisions.length - position - 1: position;
 		},
-		// Responds to slide events
+		// Responds to slide events.
 		slide: function( event, ui ) {
 			var attributes, movedRevision;
-			// Compare two revisions mode
+			// Compare two revisions mode.
 			if ( this.model.get('compareTwoMode') ) {
-				// Prevent sliders from occupying same spot
+				// Prevent sliders from occupying same spot.
 				if ( ui.values[1] === ui.values[0] ) {
 					return false;
 				}
 				if ( isRtl ) {
 					ui.values.reverse();
 					attributes.from = undefined;
 				}
 			}
 			movedRevision = this.model.revisions.at( this.getPosition( ui.value ) );
-			// If we are scrubbing, a scrub to a revision is considered a hover
+			// If we are scrubbing, a scrub to a revision is considered a hover.
 			if ( this.model.get('scrubbing') ) {
 				attributes.hoveredRevision = movedRevision;
 			}
 			this.model.set( attributes );
 		},
 		stop: function() {
 			$( window ).off('mousemove.wp.revisions');
-			this.model.updateSliderSettings(); // To snap us back to a tick mark
+			this.model.updateSliderSettings(); // To snap us back to a tick mark.
 			this.model.set({ scrubbing: false });
 		}
 	});
 	// The diff view.
 	// Maintains the URL routes so browser URL matches state.
 	revisions.Router = Backbone.Router.extend({
 		initialize: function( options ) {
 			this.model = options.model;
-			// Maintain state and history when navigating
+			// Maintain state and history when navigating.
 			this.listenTo( this.model, 'update:diff', _.debounce( this.updateUrl, 250 ) );
 			this.listenTo( this.model, 'change:compareTwoMode', this.updateUrl );
 		},
 		baseUrl: function( url ) {

enmi-conf.org