Skip to content

Data: Patch $._data & $._removeData as well, add more tests #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 3.x-stable
Choose a base branch
from
Open

Data: Patch $._data & $._removeData as well, add more tests #570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 47 additions & 75 deletions src/jquery/data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
import { migratePatchFunc, migrateWarn } from "../main.js";
import { camelCase } from "../utils.js";
import { camelCase, patchProto } from "../utils.js";

var rmultiDash = /[A-Z]/g,
rnothtmlwhite = /[^\x20\t\r\n\f]+/g,
origJQueryData = jQuery.data;
origJQueryData = jQuery.data,
origJQueryPrivateData = jQuery._data;

function unCamelCase( str ) {
return str.replace( rmultiDash, "-$&" ).toLowerCase();
}

function patchDataCamelCase( origData, options ) {
var apiName = options.apiName,
isInstanceMethod = options.isInstanceMethod;
isPrivateData = options.isPrivateData,
isInstanceMethod = options.isInstanceMethod,
origJQueryStaticData = isPrivateData ? origJQueryPrivateData : origJQueryData;

function objectSetter( elem, obj ) {
var curData, key;
Expand All @@ -23,7 +26,7 @@ function patchDataCamelCase( origData, options ) {

// Don't use the instance method here to avoid `data-*` attributes
// detection this early.
curData = origJQueryData( elem );
curData = origJQueryStaticData( elem );

for ( key in obj ) {
if ( key !== camelCase( key ) ) {
Expand Down Expand Up @@ -56,7 +59,7 @@ function patchDataCamelCase( origData, options ) {

// Don't use the instance method here to avoid `data-*` attributes
// detection this early.
curData = origJQueryData( elem );
curData = origJQueryStaticData( elem );

if ( curData && name in curData ) {
migrateWarn( "data-camelCase",
Expand All @@ -66,7 +69,7 @@ function patchDataCamelCase( origData, options ) {
curData[ name ] = value;
}

origJQueryData( elem, name, value );
origJQueryStaticData( elem, name, value );

// Since the "set" path can have two possible entry points
// return the expected data based on which path was taken.
Expand Down Expand Up @@ -124,7 +127,7 @@ function patchDataCamelCase( origData, options ) {

// Don't use the instance method here to avoid `data-*` attributes
// detection this early.
curData = origJQueryData( elem );
curData = origJQueryStaticData( elem );

if ( curData && name in curData ) {
migrateWarn( "data-camelCase",
Expand All @@ -139,11 +142,13 @@ function patchDataCamelCase( origData, options ) {
}

function patchRemoveDataCamelCase( origRemoveData, options ) {
var isInstanceMethod = options.isInstanceMethod;
var isPrivateData = options.isPrivateData,
isInstanceMethod = options.isInstanceMethod,
origJQueryStaticData = isPrivateData ? origJQueryPrivateData : origJQueryData;

function remove( elem, keys ) {
var i, singleKey, unCamelCasedKeys,
curData = jQuery.data( elem );
curData = origJQueryStaticData( elem );

if ( keys === undefined ) {
origRemoveData( elem );
Expand Down Expand Up @@ -223,104 +228,64 @@ function patchRemoveDataCamelCase( origRemoveData, options ) {
migratePatchFunc( jQuery, "data",
patchDataCamelCase( jQuery.data, {
apiName: "jQuery.data()",
isPrivateData: false,
isInstanceMethod: false
} ),
"data-camelCase" );
migratePatchFunc( jQuery, "_data",
patchDataCamelCase( jQuery._data, {
apiName: "jQuery._data()",
isPrivateData: true,
isInstanceMethod: false
} ),
"data-camelCase" );
migratePatchFunc( jQuery.fn, "data",
patchDataCamelCase( jQuery.fn.data, {
apiName: "jQuery.fn.data()",
isPrivateData: false,
isInstanceMethod: true
} ),
"data-camelCase" );

migratePatchFunc( jQuery, "removeData",
patchRemoveDataCamelCase( jQuery.removeData, {
isPrivateData: false,
isInstanceMethod: false
} ),
"data-camelCase" );
migratePatchFunc( jQuery, "_removeData",
patchRemoveDataCamelCase( jQuery._removeData, {
isPrivateData: true,
isInstanceMethod: false
} ),
"data-camelCase" );

migratePatchFunc( jQuery.fn, "removeData",

// No, it's not a typo - we're intentionally passing
// the static method here as we need something working on
// a single element.
patchRemoveDataCamelCase( jQuery.removeData, {
isPrivateData: false,
isInstanceMethod: true
} ),
"data-camelCase" );


function patchDataProto( original, options ) {

// Support: IE 9 - 10 only, iOS 7 - 8 only
// Older IE doesn't have a way to change an existing prototype.
// Just return the original method there.
// Older WebKit supports `__proto__` but not `Object.setPrototypeOf`.
// To avoid complicating code, don't patch the API there either.
if ( !Object.setPrototypeOf ) {
return original;
}

var i,
var warningId = options.warningId,
apiName = options.apiName,
isInstanceMethod = options.isInstanceMethod,

// `Object.prototype` keys are not enumerable so list the
// official ones here. An alternative would be wrapping
// data objects with a Proxy but that creates additional issues
// like breaking object identity on subsequent calls.
objProtoKeys = [
"__proto__",
"__defineGetter__",
"__defineSetter__",
"__lookupGetter__",
"__lookupSetter__",
"hasOwnProperty",
"isPrototypeOf",
"propertyIsEnumerable",
"toLocaleString",
"toString",
"valueOf"
],

// Use a null prototype at the beginning so that we can define our
// `__proto__` getter & setter. We'll reset the prototype afterwards.
intermediateDataObj = Object.create( null );

for ( i = 0; i < objProtoKeys.length; i++ ) {
( function( key ) {
Object.defineProperty( intermediateDataObj, key, {
get: function() {
migrateWarn( "data-null-proto",
"Accessing properties from " + apiName +
" inherited from Object.prototype is deprecated" );
return ( key + "__cache" ) in intermediateDataObj ?
intermediateDataObj[ key + "__cache" ] :
Object.prototype[ key ];
},
set: function( value ) {
migrateWarn( "data-null-proto",
"Setting properties from " + apiName +
" inherited from Object.prototype is deprecated" );
intermediateDataObj[ key + "__cache" ] = value;
}
} );
} )( objProtoKeys[ i ] );
}

Object.setPrototypeOf( intermediateDataObj, Object.prototype );
isInstanceMethod = options.isInstanceMethod;

return function jQueryDataProtoPatched() {
return function apiWithProtoPatched() {
var result = original.apply( this, arguments );

if ( arguments.length !== ( isInstanceMethod ? 0 : 1 ) || result === undefined ) {
return result;
}

// Insert an additional object in the prototype chain between `result`
// and `Object.prototype`; that intermediate object proxies properties
// to `Object.prototype`, warning about their usage first.
Object.setPrototypeOf( result, intermediateDataObj );
patchProto( result, {
warningId: warningId,
apiName: apiName
} );

return result;
};
Expand All @@ -330,15 +295,22 @@ function patchDataProto( original, options ) {
// so that each of the two patches can be independently disabled.
migratePatchFunc( jQuery, "data",
patchDataProto( jQuery.data, {
warningId: "data-null-proto",
apiName: "jQuery.data()",
isPrivateData: false,
isInstanceMethod: false
} ),
"data-null-proto" );
migratePatchFunc( jQuery, "_data",
patchDataProto( jQuery._data, {
warningId: "data-null-proto",
apiName: "jQuery._data()",
isInstanceMethod: false
} ),
"data-null-proto" );
migratePatchFunc( jQuery.fn, "data",
patchDataProto( jQuery.fn.data, {
warningId: "data-null-proto",
apiName: "jQuery.fn.data()",
isPrivateData: true,
isInstanceMethod: true
} ),
"data-null-proto" );
69 changes: 69 additions & 0 deletions src/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,74 @@
import { migrateWarn } from "./main.js";

export function camelCase( string ) {
return string.replace( /-([a-z])/g, function( _, letter ) {
return letter.toUpperCase();
} );
}

// Insert an additional object in the prototype chain between `objrvy`
// and `Object.prototype`; that intermediate object proxies properties
// to `Object.prototype`, warning about their usage first.
export function patchProto( object, options ) {

// Support: IE 9 - 10 only, iOS 7 - 8 only
// Older IE doesn't have a way to change an existing prototype.
// Just return the original method there.
// Older WebKit supports `__proto__` but not `Object.setPrototypeOf`.
// To avoid complicating code, don't patch the API there either.
if ( !Object.setPrototypeOf ) {
return object;
}

var i,
warningId = options.warningId,
apiName = options.apiName,

// `Object.prototype` keys are not enumerable so list the
// official ones here. An alternative would be wrapping
// objects with a Proxy but that creates additional issues
// like breaking object identity on subsequent calls.
objProtoKeys = [
"__proto__",
"__defineGetter__",
"__defineSetter__",
"__lookupGetter__",
"__lookupSetter__",
"hasOwnProperty",
"isPrototypeOf",
"propertyIsEnumerable",
"toLocaleString",
"toString",
"valueOf"
],

// Use a null prototype at the beginning so that we can define our
// `__proto__` getter & setter. We'll reset the prototype afterward.
intermediateObj = Object.create( null );

for ( i = 0; i < objProtoKeys.length; i++ ) {
( function( key ) {
Object.defineProperty( intermediateObj, key, {
get: function() {
migrateWarn( warningId,
"Accessing properties from " + apiName +
" inherited from Object.prototype is deprecated" );
return ( key + "__cache" ) in intermediateObj ?
intermediateObj[ key + "__cache" ] :
Object.prototype[ key ];
},
set: function( value ) {
migrateWarn( warningId,
"Setting properties from " + apiName +
" inherited from Object.prototype is deprecated" );
intermediateObj[ key + "__cache" ] = value;
}
} );
} )( objProtoKeys[ i ] );
}

Object.setPrototypeOf( intermediateObj, Object.prototype );
Object.setPrototypeOf( object, intermediateObj );

return object;
}
Loading
Loading