From 193036bb3f9ca531c3bcfa487d33d6fe73c337ef Mon Sep 17 00:00:00 2001 From: Craig Michael Thompson Date: Sun, 28 Nov 2010 22:57:38 +0000 Subject: [PATCH 1/5] Updated to version 2.1 released on jQuery plugins page --- jquery.metadata.js | 194 +++++++++++++++++++++++++++------------------ 1 file changed, 118 insertions(+), 76 deletions(-) diff --git a/jquery.metadata.js b/jquery.metadata.js index eb98e80..60a0f5c 100644 --- a/jquery.metadata.js +++ b/jquery.metadata.js @@ -1,19 +1,21 @@ /* * Metadata - jQuery plugin for parsing metadata from elements * - * Copyright (c) 2006 John Resig, Yehuda Katz, Jörn Zaefferer, Paul McLanahan + * Copyright (c) 2006 John Resig, Yehuda Katz, J�örn Zaefferer, Paul McLanahan * * Dual licensed under the MIT and GPL licenses: * http://www.opensource.org/licenses/mit-license.php * http://www.gnu.org/licenses/gpl.html * + * Revision: + * */ /** * Sets the type of metadata to use. Metadata is encoded in JSON, and each property * in the JSON will become a property of the element itself. * - * There are three supported types of metadata storage: + * There are four supported types of metadata storage: * * attr: Inside an attribute. The name parameter indicates *which* attribute. * @@ -21,6 +23,8 @@ * * elem: Inside a child element (e.g. a script tag). The * name parameter indicates *which* element. + * + * html5: Values are stored in data-* attributes. * * The metadata for an element is loaded the first time the element is accessed via jQuery. * @@ -29,21 +33,26 @@ * * @name $.metadata.setType * - * @example

This is a p

- * @before $.metadata.setType("class") - * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label" + * @example

This is a p

+ * @before $.metadata.setType('class') + * @after $('#one').metadata().item_id == 1; $('#one').metadata().item_label == 'Label' * @desc Reads metadata from the class attribute * - * @example

This is a p

- * @before $.metadata.setType("attr", "data") - * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label" - * @desc Reads metadata from a "data" attribute + * @example

This is a p

+ * @before $.metadata.setType('attr', 'data') + * @after $('#one').metadata().item_id == 1; $('#one').metadata().item_label == 'Label' + * @desc Reads metadata from a 'data' attribute * - * @example

This is a p

- * @before $.metadata.setType("elem", "script") - * @after $("#one").metadata().item_id == 1; $("#one").metadata().item_label == "Label" + * @example

This is a p

+ * @before $.metadata.setType('elem', 'script') + * @after $('#one').metadata().item_id == 1; $('#one').metadata().item_label == 'Label' * @desc Reads metadata from a nested script element * + * @example

This is a p

+ * @before $.metadata.setType('html5') + * @after $('#one').metadata().item_id == 1; $('#one').metadata().item_label == 'Label' + * @desc Reads metadata from a series of data-* attributes + * * @param String type The encoding type * @param String name The name of the attribute to be used to get metadata (optional) * @cat Plugins/Metadata @@ -52,69 +61,102 @@ * @see metadata() */ -(function($) { - -$.extend({ - metadata : { - defaults : { - type: 'class', - name: 'metadata', - cre: /({.*})/, - single: 'metadata' - }, - setType: function( type, name ){ - this.defaults.type = type; - this.defaults.name = name; - }, - get: function( elem, opts ){ - var settings = $.extend({},this.defaults,opts); - // check for empty string in single property - if ( !settings.single.length ) settings.single = 'metadata'; - - var data = $.data(elem, settings.single); - // returned cached data if it already exists - if ( data ) return data; - - data = "{}"; - - if ( settings.type == "class" ) { - var m = settings.cre.exec( elem.className ); - if ( m ) - data = m[1]; - } else if ( settings.type == "elem" ) { - if( !elem.getElementsByTagName ) - return undefined; - var e = elem.getElementsByTagName(settings.name); - if ( e.length ) - data = $.trim(e[0].innerHTML); - } else if ( elem.getAttribute != undefined ) { - var attr = elem.getAttribute( settings.name ); - if ( attr ) - data = attr; +(function($, window, undefined) { + + $.extend({ + metadata : { + defaults : { + type: 'class', + name: 'metadata', + cre: /({.*})/, + single: 'metadata' + }, + setType: function( type, name ){ + this.defaults.type = type; + this.defaults.name = name; + }, + get: function( elem, opts ){ + var settings = $.extend({}, this.defaults,opts), + object = {}, data, match, attr; + + // check for empty string in single property + if ( !settings.single.length ) { + settings.single = 'metadata'; + } + + data = $.data(elem, settings.single); + + // returned cached data if it already exists + if(data) { return data; } + data = '{}'; + + function getData(data) { + if('string' !== typeof data) { + return data; + } + + if(data.indexOf('{') < 0) { + data = eval('(' + data + ')'); + } + } + + function getObject(data) { + if('string' === typeof data) { + data = eval('(' + data + ')'); + } + + return data; + } + + if ( settings.type == 'html5' ) { + $( elem.attributes ).each(function() { + var name = this.nodeName; + + if(name.match(/^data-/)) { + name = name.replace(/^data-/, ''); + object[name] = getObject(this.nodeValue); + } + }); + } + else { + if(settings.type == 'class') { + match = settings.cre.exec( elem.className ); + if(match) { data = match[1]; } + } + else if(settings.type == 'elem') { + if(!elem.getElementsByTagName) { return; } + + match = elem.getElementsByTagName(settings.name); + if(match.length) { + data = $.trim(match[0].innerHTML); + } + } + else if(undefined !== elem.getAttribute) { + attr = elem.getAttribute( settings.name ); + if(attr) { data = attr; } + } + + object = getObject(data.indexOf('{') < 0 ? '{' + data + '}' : data); + } + + $.data( elem, settings.single, object ); + + return object; } - - if ( data.indexOf( '{' ) <0 ) - data = "{" + data + "}"; - - data = eval("(" + data + ")"); - - $.data( elem, settings.single, data ); - return data; } - } -}); - -/** - * Returns the metadata object for the first member of the jQuery object. - * - * @name metadata - * @descr Returns element's metadata object - * @param Object opts An object contianing settings to override the defaults - * @type jQuery - * @cat Plugins/Metadata - */ -$.fn.metadata = function( opts ){ - return $.metadata.get( this[0], opts ); -}; - -})(jQuery); \ No newline at end of file + }); + + /** + * Returns the metadata object for the first member of the jQuery object. + * + * @name metadata + * @descr Returns element's metadata object + * @param Object opts An object contianing settings to override the defaults + * @type jQuery + * @cat Plugins/Metadata + */ + $.fn.metadata = function( opts ){ + return $.metadata.get( this[0], opts ); + }; + +})(jQuery, this); \ No newline at end of file From e3ece8b5e2ffdb3db502933b7dcb3ed3a83b871e Mon Sep 17 00:00:00 2001 From: Craig Michael Thompson Date: Sun, 28 Nov 2010 22:59:04 +0000 Subject: [PATCH 2/5] Removed redundant whitespace --- jquery.metadata.js | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/jquery.metadata.js b/jquery.metadata.js index 60a0f5c..712c632 100644 --- a/jquery.metadata.js +++ b/jquery.metadata.js @@ -62,7 +62,7 @@ */ (function($, window, undefined) { - + $.extend({ metadata : { defaults : { @@ -78,23 +78,23 @@ get: function( elem, opts ){ var settings = $.extend({}, this.defaults,opts), object = {}, data, match, attr; - + // check for empty string in single property if ( !settings.single.length ) { settings.single = 'metadata'; } - + data = $.data(elem, settings.single); - + // returned cached data if it already exists if(data) { return data; } data = '{}'; - + function getData(data) { if('string' !== typeof data) { return data; } - + if(data.indexOf('{') < 0) { data = eval('(' + data + ')'); } @@ -104,7 +104,7 @@ if('string' === typeof data) { data = eval('(' + data + ')'); } - + return data; } @@ -138,14 +138,14 @@ object = getObject(data.indexOf('{') < 0 ? '{' + data + '}' : data); } - + $.data( elem, settings.single, object ); - + return object; } } }); - + /** * Returns the metadata object for the first member of the jQuery object. * @@ -158,5 +158,5 @@ $.fn.metadata = function( opts ){ return $.metadata.get( this[0], opts ); }; - + })(jQuery, this); \ No newline at end of file From 34c877f6b4610178a284807eb1ffd3da1f9386a9 Mon Sep 17 00:00:00 2001 From: Craig Michael Thompson Date: Sun, 28 Nov 2010 22:59:16 +0000 Subject: [PATCH 3/5] If empty object is the result of the metadata detection, don't apply it in case we need to re-read later with a different metadata type. --- jquery.metadata.js | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/jquery.metadata.js b/jquery.metadata.js index 712c632..3c51c04 100644 --- a/jquery.metadata.js +++ b/jquery.metadata.js @@ -139,7 +139,9 @@ object = getObject(data.indexOf('{') < 0 ? '{' + data + '}' : data); } - $.data( elem, settings.single, object ); + if( data !== '{}' ) { + $.data( elem, settings.single, object ); + } return object; } From 5ab6498b546ea53b0ca4d405458d57f3291af467 Mon Sep 17 00:00:00 2001 From: Craig Michael Thompson Date: Sun, 28 Nov 2010 23:00:41 +0000 Subject: [PATCH 4/5] Updated version number and revision number --- META.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/META.json b/META.json index 39bd319..30b3c35 100644 --- a/META.json +++ b/META.json @@ -17,7 +17,7 @@ }, "provides": { "jQuery.Metadata": { - "version": 2.0, + "version": 2.1, "file": "jquery.metadata.js" } }, From b8d97fcabe09c77bba623da391d5f4011b3c1a6d Mon Sep 17 00:00:00 2001 From: Craig Michael Thompson Date: Sun, 28 Nov 2010 23:08:18 +0000 Subject: [PATCH 5/5] Fixed some more whitespace consistency issues --- jquery.metadata.js | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/jquery.metadata.js b/jquery.metadata.js index 3c51c04..e72f02b 100644 --- a/jquery.metadata.js +++ b/jquery.metadata.js @@ -7,7 +7,7 @@ * http://www.opensource.org/licenses/mit-license.php * http://www.gnu.org/licenses/gpl.html * - * Revision: + * Version: 2.1 * */ @@ -77,17 +77,17 @@ }, get: function( elem, opts ){ var settings = $.extend({}, this.defaults,opts), - object = {}, data, match, attr; + object = {}, data, match, attr; // check for empty string in single property if ( !settings.single.length ) { settings.single = 'metadata'; } - data = $.data(elem, settings.single); - // returned cached data if it already exists + data = $.data(elem, settings.single); if(data) { return data; } + data = '{}'; function getData(data) { @@ -108,38 +108,42 @@ return data; } - if ( settings.type == 'html5' ) { + if(settings.type == 'html5') { $( elem.attributes ).each(function() { var name = this.nodeName; if(name.match(/^data-/)) { name = name.replace(/^data-/, ''); - object[name] = getObject(this.nodeValue); + object[name] = getObject( this.nodeValue ); } }); } else { if(settings.type == 'class') { match = settings.cre.exec( elem.className ); - if(match) { data = match[1]; } + if(match) { + data = match[1]; + } } else if(settings.type == 'elem') { if(!elem.getElementsByTagName) { return; } - match = elem.getElementsByTagName(settings.name); + match = elem.getElementsByTagName( settings.name ); if(match.length) { data = $.trim(match[0].innerHTML); } } else if(undefined !== elem.getAttribute) { attr = elem.getAttribute( settings.name ); - if(attr) { data = attr; } + if(attr) { + data = attr; + } } - + object = getObject(data.indexOf('{') < 0 ? '{' + data + '}' : data); } - if( data !== '{}' ) { + if(data !== '{}') { $.data( elem, settings.single, object ); }