sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Revisions: Bunch of refactoring and code cleanup

Browse Source 
* Extracted a lot of model-y stuff from the view code.
* Slider now has a proper model, with communication with other models.
* Use of `get( foo )` instead of `findWhere({ id: foo })`.
* Properly set the `from` diff when routing single mode.
* Bind `prev()` and `next()` to their model.
* Tick marks are now percentage based, which means the slider resizes with the browser, without JS resize events.
* When scrubbing, the position of the scrubber is considered a hover, so you can fall off the timeline while still scrubbing and the tooltips will persist.
* Tooltips fade in and out.
* Tooltips hang around for a grace period instead of immediately going away. More forgiving.
* Unused code paths removed.
* Got rid of a bunch of view-to-view communication.
* Use `_.times()` instead of a `for` loop.
* Removed premature `Math.floor()` and `Math.ceil()` calls that were making things not add up to 100%.

See #24425.

git-svn-id: https://develop.svn.wordpress.org/trunk@24658 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Mark Jaquith 2013-07-11 09:14:14 +00:00
parent b018ab15f1
commit c5d53046a9
3 changed files with 213 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-admin/css/colors-fresh.css
View File

@ -1391,7 +1391,7 @@ table.diff .diff-addedline ins {
} }
.revisions-tickmarks > div { .revisions-tickmarks > div {
background-color: #ccc; border-color: #aaa;
} }
#diff-title-to strong { #diff-title-to strong {

34
wp-admin/css/wp-admin.css
View File

@ -2549,15 +2549,19 @@ tr.wp-locked .row-actions .trash {
tr .locked-info { tr .locked-info {
height: 0; height: 0;
opacity: 0; opacity: 0;
-webkit-transition: height 1s, opacity 500ms;
transition: height 1s, opacity 500ms;
} }
tr.wp-locked .locked-info { tr.wp-locked .locked-info {
height: 22px; height: 22px;
opacity: 1; opacity: 1;
-webkit-transition: height 1s, opacity 500ms 500ms; }
transition: height 1s, opacity 500ms 500ms;
tr.locked-info, tr.wp-locked .locked-info {
-webkit-transition: height 1s, opacity 500ms;
-moz-transition: height 1s, opacity 500ms;
-ms-transition: height 1s, opacity 500ms;
-o-transition: height 1s, opacity 500ms;
transition: height 1s, opacity 500ms;
} }
.fixed .column-comments .sorting-indicator { .fixed .column-comments .sorting-indicator {
@ -3512,14 +3516,22 @@ td.plugin-title p {
height: 0.8em; height: 0.8em;
z-index: 2; z-index: 2;
top: 7px; top: 7px;
width: 70%;
box-sizing: border-box;
} }
.revisions-tickmarks > div { .revisions-tickmarks > div {
height: 0.8em;
width: 1px;
float: left;
position: relative; position: relative;
height: 100%;
float: left;
z-index: 10002; z-index: 10002;
border-style: solid;
border-width: 0 0 0 1px;
box-sizing: border-box;
}
.revisions-tickmarks > div:first-of-type {
border-left-width: 0;
} }
.comparing-two-revisions .revisions-controls { .comparing-two-revisions .revisions-controls {
@ -3654,6 +3666,14 @@ table.diff .diff-addedline ins {
padding: 4px; padding: 4px;
} }
.revisions-tooltip.fade {
-webkit-transition: opacity 200ms;
-ms-transition: opacity 200ms;
-moz-transition: opacity 200ms;
-o-transition: opacity 200ms;
transition: opacity 200ms;
}
.comparing-two-revisions .revisions-tooltip { .comparing-two-revisions .revisions-tooltip {
bottom: 145px; bottom: 145px;
} }

318
wp-admin/js/revisions.js
View File

@ -31,14 +31,87 @@ window.wp = window.wp || {};
value: 0, value: 0,
min: 0, min: 0,
max: 1, max: 1,
step: 1 step: 1,
compareTwoMode: false
},
initialize: function( options ) {
this.frame = options.frame;
this.revisions = options.revisions;
this.set({
max: this.revisions.length - 1,
value: this.revisions.indexOf( this.revisions.get( revisions.settings.selectedRevision ) ),
compareTwoMode: this.frame.get('compareTwoMode')
});
// 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
this.listenTo( this, 'change:from', this.handleLocalChanges );
this.listenTo( this, 'change:to', this.handleLocalChanges );
// Listen for changes to the hovered revision
this.listenTo( this, 'change:hoveredRevision', this.hoverRevision );
},
// Called when a revision is hovered
hoverRevision: function( model, value ) {
this.trigger( 'hovered:revision', value );
},
// Called when `compareTwoMode` changes
updateMode: function( model, value ) {
this.set({ compareTwoMode: value });
},
// 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
receiveRevisions: function( from, to ) {
// Bail if nothing changed
if ( this.get('from') === from && this.get('to') === to )
return;
this.set({ from: from, to: to }, { silent: true });
this.trigger( 'update:revisions', from, to );
} }
}); });
revisions.model.Tooltip = Backbone.Model.extend({ revisions.model.Tooltip = Backbone.Model.extend({
defaults: { defaults: {
revision: null, revision: null,
position: 0 hovering: false, // Whether the mouse is hovering
scrubbing: false // Whether the mouse is scrubbing
},
initialize: function( options ) {
this.revisions = options.revisions;
this.slider = options.slider;
this.listenTo( this.slider, 'hovered:revision', this.updateRevision );
this.listenTo( this.slider, 'change:hovering', this.setHovering );
this.listenTo( this.slider, 'change:scrubbing', this.setScrubbing );
},
updateRevision: function( revision ) {
this.set({ revision: revision });
},
setHovering: function( model, value ) {
this.set({ hovering: value });
},
setScrubbing: function( model, value ) {
this.set({ scrubbing: value });
} }
}); });
@ -47,6 +120,10 @@ window.wp = window.wp || {};
revisions.model.Revisions = Backbone.Collection.extend({ revisions.model.Revisions = Backbone.Collection.extend({
model: revisions.model.Revision, model: revisions.model.Revision,
initialize: function() {
_.bindAll( this, 'next', 'prev' );
},
comparator: function( a, b ) { comparator: function( a, b ) {
var a_ = a.get('dateUnix'); var a_ = a.get('dateUnix');
var b_ = b.get('dateUnix'); var b_ = b.get('dateUnix');
@ -401,21 +478,28 @@ window.wp = window.wp || {};
model: this.model model: this.model
}) ); }) );
// Add the tooltip view // Prep the slider model
var tooltip = new revisions.view.Tooltip({ var slider = new revisions.model.Slider({
model: new revisions.model.Tooltip() frame: this.model,
revisions: this.model.revisions
}); });
this.views.add( tooltip );
// Add the Tickmarks view // Add the tooltip view
this.views.add( new revisions.view.Tooltip({
model: new revisions.model.Tooltip({
revisions: this.model.revisions,
slider: slider
})
}) );
// Add the tickmarks view
this.views.add( new revisions.view.Tickmarks({ this.views.add( new revisions.view.Tickmarks({
model: this.model model: this.model
}) ); }) );
// Add the Slider view with a reference to the tooltip view // Add the slider view
this.views.add( new revisions.view.Slider({ this.views.add( new revisions.view.Slider({
model: this.model, model: slider
tooltip: tooltip
}) ); }) );
// Add the Meta view // Add the Meta view
@ -431,28 +515,20 @@ window.wp = window.wp || {};
revisions.view.Tickmarks = wp.Backbone.View.extend({ revisions.view.Tickmarks = wp.Backbone.View.extend({
className: 'revisions-tickmarks', className: 'revisions-tickmarks',
numberOfTickmarksSet: function() { render: function() {
var tickCount = this.model.revisions.length - 1, // One tickmark per model var tickCount, tickWidth;
sliderWidth = $('.wp-slider').parent().width() * 0.7, // Width of slider is 70% of container (reset on resize)
tickWidth = Math.floor( sliderWidth / tickCount ), // Divide width by # of tickmarks, round down
newSiderWidth = ( ( tickWidth + 1 ) * tickCount ) + 1, // Calculate the actual width
tickNumber;
$('.wp-slider').css( 'width', newSiderWidth ); // Reset the slider width to match the calculated tick size tickCount = this.model.revisions.length - 1;
this.$el.css( 'width', newSiderWidth ); // Match the tickmark div width tickWidth = 1 / tickCount;
for ( tickNumber = 0; tickNumber <= tickCount; tickNumber++ ){ this.$el.html('');
this.$el.append('<div style="left:' + ( tickWidth * tickNumber ) + 'px;"></div>'); _(tickCount).times( function(){ this.$el.append( '<div></div>' ); }, this );
}
this.$('div').css( 'width', ( 100 * tickWidth ) + '%' );
}, },
ready: function() { ready: function() {
var self = this; this.render();
self.numberOfTickmarksSet();
$( window ).on( 'resize', _.debounce( function() {
self.$el.html('');
self.numberOfTickmarksSet();
}, 50 ) );
} }
}); });
@ -527,34 +603,53 @@ window.wp = window.wp || {};
className: 'revisions-tooltip', className: 'revisions-tooltip',
template: wp.template('revisions-tooltip'), template: wp.template('revisions-tooltip'),
initialize: function() { initialize: function( options ) {
this.listenTo( this.model, 'change', this.render ); this.listenTo( this.model, 'change:revision', this.render );
this.listenTo( this.model, 'change:hovering', this.toggleVisibility );
this.listenTo( this.model, 'change:scrubbing', this.toggleVisibility );
}, },
ready: function() { ready: function() {
// Hide tooltip on start. this.toggleVisibility({ immediate: true });
this.$el.addClass('hidden');
}, },
show: function() { visible: function() {
this.$el.removeClass('hidden'); return this.model.get( 'scrubbing' ) || this.model.get( 'hovering' );
}, },
hide: function() { toggleVisibility: function( options ) {
this.$el.addClass('hidden'); options = options || {};
var visible = this.visible()
if ( visible ) { // Immediate show
// this.$el.removeClass('fade');
this.$el.css( 'opacity', 1 );
} else if ( options.immediate ) { // Immediate fade out
this.$el.addClass('fade');
this.$el.css( 'opacity', 0 );
} else { // Wait a bit, make sure we're really done, then fade it out
_.delay( function( view ) {
if ( ! view.visible() )
view.toggleVisibility({ immediate: true });
}, 500, this );
}
}, },
render: function() { render: function() {
var offset;
// Check if a revision exists. // Check if a revision exists.
if ( null === this.model.get('revision') ) if ( _.isNull( this.model.get('revision') ) )
return; return;
// Insert revision data. // Insert revision data.
this.$el.html( this.template( this.model.get('revision').toJSON() ) ); this.$el.html( this.template( this.model.get('revision').toJSON() ) );
// Set the position. // Set the position.
var offset = $('.revisions-buttons').offset().left; offset = this.model.revisions.indexOf( this.model.get('revision') ) / ( this.model.revisions.length - 1 );
this.$el.css( 'left', this.model.get('position') - offset ); // 15% to get us to the start of the slider
// 0.7 to convert the slider-relative percentage to a page-relative percentage
// 100 to convert to a percentage
offset = 15 + (0.7 * offset * 100 ); // Now in a percentage
this.$el.css( 'left', offset + '%' );
} }
}); });
@ -626,67 +721,38 @@ window.wp = window.wp || {};
// The slider view. // The slider view.
// Encapsulates all of the configuration for the jQuery UI slider into a view.
revisions.view.Slider = wp.Backbone.View.extend({ revisions.view.Slider = wp.Backbone.View.extend({
className: 'wp-slider', className: 'wp-slider',
events: { events: {
'mousemove' : 'mousemove', 'mousemove' : 'mouseMove',
'mouseleave' : 'mouseleave', 'mouseleave' : 'mouseLeave',
'mouseenter' : 'mouseenter' 'mouseenter' : 'mouseEnter'
}, },
initialize: function( options ) { initialize: function() {
_.bindAll( this, 'start', 'slide', 'stop' ); _.bindAll( this, 'start', 'slide', 'stop', 'mouseMove' );
this.listenTo( this.model, 'change:compareTwoMode', this.updateSliderSettings );
this.tooltip = options.tooltip; this.listenTo( this.model, 'update:revisions', this.updateSliderSettings );
// Create the slider model from the provided collection data.
var latestRevisionIndex = this.model.revisions.length - 1;
// Find the initially selected revision
var initiallySelectedRevisionIndex =
this.model.revisions.indexOf(
this.model.revisions.findWhere({ id: revisions.settings.selectedRevision }) );
this.settings = new revisions.model.Slider({
max: latestRevisionIndex,
value: initiallySelectedRevisionIndex,
start: this.start,
slide: this.slide,
stop: this.stop
});
}, },
ready: function() { ready: function() {
// Refresh the currently selected revision position in case router has set it. this.$el.slider( _.extend( this.model.toJSON(), {
this.settings.attributes.value = this.model.revisions.indexOf( start: this.start,
this.model.revisions.findWhere({ id: revisions.settings.selectedRevision }) ); slide: this.slide,
stop: this.stop
}) );
// And update the slider in case the route has set it. this.listenTo( this, 'slide:stop', this.updateSliderSettings );
this.updateSliderSettings();
this.slide( '', this.settings.attributes );
this.$el.slider( this.settings.toJSON() );
// Listen for changes in Compare Two Mode setting
this.listenTo( this.model, 'change:compareTwoMode', this.updateSliderSettings );
this.settings.on( 'change', function() {
this.updateSliderSettings();
}, this );
// Listen for changes to the revisions
this.listenTo( this.model, 'update:revisions', this.updateRevisions );
}, },
mousemove: function( e ) { mouseMove: function( e ) {
var tickCount = this.model.revisions.length - 1, // One tickmark per model var zoneCount = this.model.revisions.length - 1, // One fewer zone than models
sliderLeft = Math.ceil( this.$el.offset().left ), // Left edge of slider sliderLeft = this.$el.offset().left, // Left edge of slider
sliderWidth = this.$el.width(), // Width of slider sliderWidth = this.$el.width(), // Width of slider
tickWidth = Math.floor( sliderWidth / tickCount ), // Calculated width of tickmark tickWidth = sliderWidth / zoneCount, // Calculated width of zone
actualX = e.clientX - sliderLeft, // Offset of mouse position in slider actualX = e.clientX - sliderLeft, // Offset of mouse position in slider
currentModelIndex = Math.floor( ( actualX + tickWidth / 2 ) / tickWidth ), // Calculate the model index currentModelIndex = Math.floor( ( actualX + ( tickWidth / 2 ) ) / tickWidth ); // Calculate the model index
tooltipPosition = sliderLeft + 2 + currentModelIndex * tickWidth; // Stick tooltip to tickmark
// Reverse direction in RTL mode. // Reverse direction in RTL mode.
if ( isRtl ) if ( isRtl )
@ -699,40 +765,27 @@ window.wp = window.wp || {};
currentModelIndex = this.model.revisions.length - 1; currentModelIndex = this.model.revisions.length - 1;
// Update the tooltip model // Update the tooltip model
this.tooltip.model.set( 'revision', this.model.revisions.at( currentModelIndex ) ); this.model.set({
this.tooltip.model.set( 'position', tooltipPosition ); 'hoveredRevision': this.model.revisions.at( currentModelIndex )
});
}, },
mouseleave: function( e ) { mouseLeave: function() {
this.tooltip.hide(); this.model.set({ hovering: false });
}, },
mouseenter: function( e ) { mouseEnter: function() {
this.tooltip.show(); this.model.set({ hovering: true });
}, },
updateSliderSettings: function() { updateSliderSettings: function() {
var handles; var handles, leftValue, rightValue;
if ( this.model.get('compareTwoMode') ) { if ( this.model.get('compareTwoMode') ) {
var leftValue, rightValue; leftValue = isRtl ? this.model.revisions.length - this.model.revisions.indexOf( this.model.get('to') ) - 1 :
// In single handle mode, the 1st stored revision is 'blank' and the 'from' model is not set
// In this case we move the to index over one
if ( _.isUndefined( this.model.get('from') ) ) {
if ( isRtl ) {
leftValue = this.model.revisions.length - this.model.revisions.indexOf( this.model.get('to') ) - 2;
rightValue = leftValue + 1;
} else {
leftValue = this.model.revisions.indexOf( this.model.get('to') );
rightValue = leftValue + 1;
}
} else {
leftValue = isRtl ? this.model.revisions.length - this.model.revisions.indexOf( this.model.get('to') ) - 1 :
this.model.revisions.indexOf( this.model.get('from') ), this.model.revisions.indexOf( this.model.get('from') ),
rightValue = isRtl ? this.model.revisions.length - this.model.revisions.indexOf( this.model.get('from') ) - 1 : rightValue = isRtl ? this.model.revisions.length - this.model.revisions.indexOf( this.model.get('from') ) - 1 :
this.model.revisions.indexOf( this.model.get('to') ); this.model.revisions.indexOf( this.model.get('to') );
}
// Set handles to current from / to models. // Set handles to current from / to models.
// Reverse order for RTL // Reverse order for RTL
@ -766,27 +819,17 @@ window.wp = window.wp || {};
} }
}, },
updateRevisions: function( from, to ) {
// Update the view settings when the revisions have changed.
if ( this.model.get('compareTwoMode') ) {
this.settings.set({ 'values': [
this.model.revisions.indexOf( from ),
this.model.revisions.indexOf( to )
] });
} else {
this.settings.set({ 'value': this.model.revisions.indexOf( to ) });
}
},
getSliderPosition: function( ui ){ getSliderPosition: function( ui ){
return isRtl ? this.model.revisions.length - ui.value - 1 : ui.value; return isRtl ? this.model.revisions.length - ui.value - 1 : ui.value;
}, },
start: function( event, ui ) { start: function( event, ui ) {
this.model.set({ scrubbing: true });
// Track the mouse position to enable smooth dragging, // Track the mouse position to enable smooth dragging,
// overrides default jQuery UI step behavior. // overrides default jQuery UI step behavior.
$( window ).on( 'mousemove', { view: this }, function( e ) { $( window ).on( 'mousemove.wp.revisions', { view: this }, function( e ) {
var view = e.data.view, var view = e.data.view,
leftDragBoundary = view.$el.offset().left, // Initial left boundary leftDragBoundary = view.$el.offset().left, // Initial left boundary
sliderOffset = leftDragBoundary, sliderOffset = leftDragBoundary,
sliderRightEdge = leftDragBoundary + view.$el.width(), sliderRightEdge = leftDragBoundary + view.$el.width(),
@ -796,7 +839,7 @@ window.wp = window.wp || {};
// In two handle mode, ensure handles can't be dragged past each other. // In two handle mode, ensure handles can't be dragged past each other.
// Adjust left/right boundaries and reset points. // Adjust left/right boundaries and reset points.
if ( view.model.get('compareTwoMode') ) { if ( view.model.frame.get('compareTwoMode') ) {
var rightHandle = $( ui.handle ).parent().find('.right-handle'), var rightHandle = $( ui.handle ).parent().find('.right-handle'),
leftHandle = $( ui.handle ).parent().find('.left-handle'); leftHandle = $( ui.handle ).parent().find('.left-handle');
@ -834,10 +877,11 @@ window.wp = window.wp || {};
} ); } );
}, },
// Responds to slide events
slide: function( event, ui ) { slide: function( event, ui ) {
var attributes; var attributes;
// Compare two revisions mode // Compare two revisions mode
if ( ! _.isUndefined( ui.values ) && this.model.get('compareTwoMode') ) { if ( ! _.isUndefined( ui.values ) && this.model.frame.get('compareTwoMode') ) {
// Prevent sliders from occupying same spot // Prevent sliders from occupying same spot
if ( ui.values[1] === ui.values[0] ) if ( ui.values[1] === ui.values[0] )
return false; return false;
@ -858,16 +902,22 @@ window.wp = window.wp || {};
if ( sliderPosition ) // Reverse directions for RTL. if ( sliderPosition ) // Reverse directions for RTL.
attributes.from = this.model.revisions.at( sliderPosition - 1 ); attributes.from = this.model.revisions.at( sliderPosition - 1 );
else else
this.model.unset( 'from', { silent: true }); attributes.from = undefined;
} }
this.model.set( attributes ); this.model.set( attributes );
// If we are scrubbing, a scrub to a revision is considered a hover
if ( this.model.get( 'scrubbing' ) ) {
this.model.set({
'hoveredRevision': attributes.to
});
}
}, },
stop: function( event, ui ) { stop: function( event, ui ) {
$( window ).off('mousemove'); $( window ).off('mousemove.wp.revisions');
this.updateSliderSettings();
// Reset settings props handle back to the step position. this.model.set({ scrubbing: false });
this.settings.trigger('change');
} }
}); });
@ -912,8 +962,10 @@ window.wp = window.wp || {};
// If `b` is undefined, this is an 'at/:to' route, for a single revision // If `b` is undefined, this is an 'at/:to' route, for a single revision
if ( _.isUndefined( b ) ) { if ( _.isUndefined( b ) ) {
b = a; b = this.model.revisions.get( a );
a = 0; a = this.model.revisions.prev( b );
b = b ? b.id : 0;
a = a ? a.id : 0
compareTwo = false; compareTwo = false;
} else { } else {
compareTwo = true; compareTwo = true;
@ -925,8 +977,8 @@ window.wp = window.wp || {};
this.model.set({ compareTwoMode: compareTwo }); this.model.set({ compareTwoMode: compareTwo });
if ( ! _.isUndefined( this.model ) ) { if ( ! _.isUndefined( this.model ) ) {
var selectedToRevision = this.model.revisions.findWhere({ id: to }), var selectedToRevision = this.model.revisions.get( to ),
selectedFromRevision = this.model.revisions.findWhere({ id: from }); selectedFromRevision = this.model.revisions.get( from );
this.model.set({ this.model.set({
to: selectedToRevision, to: selectedToRevision,