MINOR Using jquery.concrete and jquery.selector on github through piston dependency management

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@92542 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2009-11-21 02:31:55 +00:00
parent d95f867945
commit 4b1293771d
18 changed files with 416 additions and 61 deletions

View File

@ -29,12 +29,12 @@ class CalendarDateField extends DateField {
// javascript: concrete
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.concrete.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.concrete.js');
// javascript: custom
Requirements::javascript(SAPPHIRE_DIR . '/javascript/CalendarDateField.js');

View File

@ -60,12 +60,12 @@ class TabSet extends CompositeField {
Requirements::css(SAPPHIRE_DIR . '/thirdparty/jquery-ui-themes/smoothness/ui.tabs.css');
// concrete
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.concrete.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.concrete.js');
Requirements::javascript(SAPPHIRE_DIR . '/javascript/TabSet.js');

View File

@ -344,12 +344,12 @@ class Security extends Controller {
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-ui/ui.tabs.js');
// concrete
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/jquery.concrete.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.class.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.specifity.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-selector/src/jquery.selector.matches.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.dat.js');
Requirements::javascript(SAPPHIRE_DIR . '/thirdparty/jquery-concrete/src/jquery.concrete.js');
Requirements::css(THIRDPARTY_DIR . '/jquery/themes/smoothness/ui.all.css');
Requirements::css(THIRDPARTY_DIR . '/jquery/themes/smoothness/ui.tabs.css');

View File

2
thirdparty/jquery-concrete/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
vendor/
spec/

View File

@ -0,0 +1,8 @@
---
format: 1
handler:
commit: c857ed5d684031115a2bb369f601c7147a2c69bc
branch: master
lock: false
repository_url: git://github.com/hafriedlander/jquery.concrete.git
repository_class: Piston::Git::Repository

10
thirdparty/jquery-concrete/LICENSE vendored Normal file
View File

@ -0,0 +1,10 @@
Copyright (C) 2009 Hamish Friedlander (hamish@silverstripe.com) and SilverStripe Limited (www.silverstripe.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Hamish Friedlander nor SilverStripe nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View File

@ -0,0 +1,267 @@
h1. Concrete - Support for ConcreteUI programming in jQuery
A basic desire for jQuery programming is some sort of OO or other organisational method for code. For your consideration,
we provide a library for ConcreteUI style programming. In ConcreteUI you attach behavioral code to DOM objects. Concrete extends this
concept beyond what is provided by other libraries to provide a very easy to use system with class like, ploymorphic, namespaced properties
h2. Basic use
h4. First intro
To attach methods to DOM nodes, call the `concrete` function on a jQuery selector object, passing a hash listing the method names and bodys
<pre><code>
$('div').concrete({
foo: function(..){..},
bar: function(..){..}
});
</code></pre>
You can then call those methods on any jQuery object.
<pre><code>
$('#a').foo();
</code></pre>
Any elements in the jQuery selection that match the selector used during definition ('div' in this example) will have foo called with that element
set as this. Any other objects are skipped. The return value will be the return value of foo() for the last matched DOM object in the set
h4. A proper example
Given this DOM structure:
<pre><code>
<body>
<div class="internal_text">Internal text</div>
<div class="attribute_text" rel="Attribute text"></div>
<div>Nonsense</div>
</body>
</code></pre>
And this concrete definition
<pre><code>
$('.internal_text').concrete({
foo: function(){ console.log(this.text()); }
});
$('.attribute_text').concrete({
foo: function(){ console.log(this.attr('rel')); }
});
</code></pre>
Then this call
<pre><code>
$('div').foo();
</code></pre>
Will log this to the console
<pre><code>
Internal text
Attribute text
</code></pre>
h4. Limitations
When defining methods, the jQuery object that concrete is called on must be a plain selector, without context. These examples will not work
<pre><code>
$('div', el).concrete(...)
$([ela, elb, elc]).concrete(...)
$('<div id="a"></div>').concrete(...)
</code></pre>
h2. Live
The definitions you provide are not bound to the elements that match at definition time. You can declare behaviour prior to the DOM existing in any
form (i.e. prior to DOMReady) and later calls will function correctly.
h2. Selector specifity
When there are two definitions for a particular method on a particular DOM node, the function with the most _specific_ selector is used.
_Specifity_ is calculated as defined by the CSS 2/3 spec. This can be seen as _subclassing_ applied to behaviour.
Another example. Given this DOM structure
<pre><code>
<body>
<div>Internal text</div>
<div class="attribute_text" rel="Attribute text"></div>
<div>Nonsense</div>
</body>
</code></pre>
And this concrete definition
<pre><code>
$('div').concrete({
foo: function(){ console.log(this.text()); }
});
$('.attribute_text').concrete({
foo: function(){ console.log(this.attr('rel')); }
});
</code></pre>
Then this call
<pre><code>
$('div').foo();
</code></pre>
Will log this to the console
<pre><code>
Internal text
Attribute text
Nonsense
</code></pre>
h2. Events
If you declare a function with a name starting with 'on', then instead of defining that function, it will be bound to an event of that
name. Just like other functions this binding will be live, and only the most specific definition will be used
<pre><code>
<head>
<script type='text/javascript'>
/* No need for onready wrapper. Events are bound as needed */
$('div').concrete({
onclick: function(){ this.css({backgroundColor: 'blue'}); }
});
$('.green').concrete({
onclick: function(){ this.css({color: 'green'}); }
});
</script>
<body>
<div>Background will turn blue when clicked on</div>
<div>Will also have blue background when clicked on</div>
<div class='green'>Will have green text when clicked on. Background color will not change</div>
</body>
</code></pre>
h2. Constructors / Destructors
Declaring a function with the name `onmatch` will create a behavior that is called on each object when it matches. Likewise, `onunmatch` will
be called when an object that did match this selector stops matching it (because it is removed, or because you've changed its properties).
Note that an onunmatch block must be paired with an onmatch block - an onunmatch without an onmatch _in the same concrete definition block_ is illegal
Like other functions, only the most specific definition will be used. However, because property changes are not atomic, this may not work as you
expect.
h2. Namespaces
To avoid name clashes, to allow multiple bindings to the same event, and to generally seperate a set of functions from other code you can use namespaces
<pre><code>
$('div').concrete('foo.bar', function($){ return {
baz: function(){}
}});
</code></pre>
You can then call these functions like this:
<pre><code>
$('div').concrete('foo.bar').baz()
</code></pre>
Namespaced functions work just like regular functions (`this` is still set to a matching DOM Node). However, specifity is calculated per namespace.
This is particularly useful for events, because given this:
<pre><code>
$('div').concrete({
onclick: function(){ this.css({backgroundColor: 'blue'}); }
});
$('div').concrete('foo', function($){ return {
onclick: function(){ this.css({color: 'green'}); }
}});
</code></pre>
Clicking on a div will change the background **and** foreground color.
This is particularly important when writing reusable code, since otherwise you can't know before hand whether your event handler will be called or not
Although a namespace can be any string, best practise is to name them with dotted-identifier notation.
h4. Namespaces and scope (or What the hell's up with that ugly function closure)
Inside a namespace definition, functions remember the namespace they are in, and calls to other functions will be looked up inside that namespace first.
Where they don't exist, they will be looked up in the base namespace
<pre><code>
$('div').concrete('foo', {
bar: function() { this.baz(); this.qux(); }
baz: function() { console.log('baz'); }
})
$('div').concrete({
qux: function() { console.log('qux'); }
})
</code></pre>
Will print baz, qux to the console
Note that 'exists' means that a function is declared in this namespace for _any_ selector, not just a matching one. Given the dom
<pre><code>
<div>Internal text</div>
</code></pre>
And the concrete definitions
<pre><code>
$('div').concrete('foo', {
bar: function() { this.baz(); }
})
$('span').concrete('foo' {
baz: function() { console.log('a'); }
$('div').concrete({
baz: function() { console.log('b'); }
})
</code></pre>
Then doing $('div').bar(); will _not_ display b. Even though the span rule could never match a div, because baz is defined for some rule in the foo namespace, the base namespace will never be checked
h4. Forcing base
In some situations (such as the last example) you may want to force using the base namespace. In this case you can call concrete without any arguments. For example, if the first definition in the previous example was
<pre><code>
$('div').concrete('foo', {
bar: function() { this.concrete().baz(); }
})
</code></pre>
Then b _would_ be output to the console. It is up to the developer to decide when they need to be explicit about using the base namespace
h4. Using
Sometimes a block outside of a namespace will need to refer to that namespace repeatedly. By passing a function to the concrete function, you can change the looked-up namespace
<pre><code>
$('div').concrete('foo', {
bar: function() { console.log('a'); }
})
$('div').concrete('foo', function(){
this.bar();
});
</code></pre>
This equivilent to /with/ in javascript, and just like /with/, care should be taken to only use this construct in situations that merit it.

View File

@ -10,7 +10,10 @@ var console;
/** Utility to optionally display warning messages depending on level */
var warn = function(message, level) {
if (level <= $.concrete.warningLevel && console && console.log) console.log(message);
if (level <= $.concrete.warningLevel && console && console.log) {
console.warn(message);
if (console.trace) console.trace();
}
}
/** A property definition */
@ -100,16 +103,28 @@ var console;
name = name || '__base';
this.name = name;
this.proxies = {};
this.store = {};
namespaces[name] = this;
var self = this;
if (name == "__base") {
this.injectee = $.fn
this.$ = $;
}
else {
// We're in a namespace, so we build a Class that subclasses the jQuery Object Class to inject namespace functions into
var subfn = function(jq){
this.selector = jq.selector; this.context = jq.context; this.setArray($.makeArray(jq));
}
this.injectee = subfn.prototype = new $();
// And then we provide an overriding $ that returns objects of our new Class
this.$ = function() {
var jq = $.apply(window, arguments);
jq.namespace = self;
return jq;
return new subfn($.apply(window, arguments));
}
// Copy static functions through from $ to this.$ so e.g. $.ajax still works
// @bug, @cantfix: Any class functions added to $ after this call won't get mirrored through
$.extend(this.$, $);
}
},
@ -148,7 +163,7 @@ var console;
var one = this.one(name, 'func');
var prxy = function() {
var rv, ctx = $(this.__context || this);
var rv, ctx = $(this);
var i = ctx.length;
while (i--) rv = one(ctx[i], arguments);
@ -158,40 +173,23 @@ var console;
return prxy;
},
build_jquery_injection: function(name) {
if (!$.fn[name]) {
$.fn[name] = function() {
// Try bound namespace
var namespace = this.namespace;
// If that doesn't exist, or doesn't have function, try root namespace
if (!namespace || !namespace.proxies[name]) namespace = namespaces.__base;
// If that doesn't exist, throw error
if (!namespace.proxies[name]) {
throw new ReferenceError('Concrete function '+name+' not found in ' + (this.namespace ? ('namespace '+this.namespace.name+' or root namespace') : 'root namespace'));
}
namespace.__context = null;
return namespace.proxies[name].apply(this, arguments);
}
$.fn[name].concrete = true;
}
if (!$.fn[name].concrete) {
warn('Warning: Concrete function '+name+' clashes with regular jQuery function - concrete function will not be callable directly on jQuery object', $.concrete.WARN_LEVEL_IMPORTANT);
}
},
bind_proxy: function(selector, name, func) {
var funcs = this.store[name] || (this.store[name] = []) ;
var rule = funcs[funcs.length] = Rule(selector, name); rule.func = func;
funcs.sort(Rule.compare);
if (!this.proxies[name]) this.proxies[name] = this.build_proxy(name);
this.build_jquery_injection(name);
if (!this.injectee.hasOwnProperty(name)) {
this.injectee[name] = this.build_proxy(name);
this.injectee[name].concrete = true;
}
if (!this.injectee[name].concrete) {
warn('Warning: Concrete function '+name+' clashes with regular jQuery function - concrete function will not be callable directly on jQuery object', $.concrete.WARN_LEVEL_IMPORTANT);
}
},
bind_event: function(selector, name, func) {
bind_event: function(selector, name, func, event) {
var funcs = this.store[name] || (this.store[name] = []) ;
var rule = funcs[funcs.length] = Rule(selector, name); rule.func = func;
@ -199,7 +197,7 @@ var console;
if (!funcs.proxy) {
funcs.proxy = this.build_proxy(name);
$(selector.selector).live(match[1], funcs.proxy);
$(selector.selector).live(event, funcs.proxy);
}
},
@ -240,22 +238,36 @@ var console;
},
add: function(selector, data) {
for (var k in data) {
var v = data[k];
var k, v, match, event;
for (k in data) {
v = data[k];
if ($.isFunction(v)) {
if (k == 'onmatch' || k == 'onunmatch') {
this.bind_condesc(selector, k, v);
}
else if (match = k.match(/^on(.*)/)) {
this.bind_event(selector, k, v);
event = match[1];
if (!$.fn.liveHover && $.concrete.event_needs_extensions[event]) {
warn('Event '+event+' requires live-extensions to function, which does not seem to be present', $.concrete.WARN_LEVEL_IMPORTANT);
}
else if (event == 'submit') {
warn('Event submit not currently supported', $.concrete.WARN_LEVEL_IMPORTANT);
}
else if (event == 'focus' || event == 'blur') {
warn('Event '+event+' not supported - use focusin / focusout instead', $.concrete.WARN_LEVEL_IMPORTANT);
}
this.bind_event(selector, k, v, event);
}
else {
this.bind_proxy(selector, k, v);
}
}
else {
var g, s;
var g, s, p;
if (k.charAt(0) != k.charAt(0).toUpperCase()) warn('Concrete property '+k+' does not start with a capital letter', $.concrete.WARN_LEVEL_BESTPRACTISE);
@ -263,7 +275,7 @@ var console;
g = v.getter(); s = v.setter();
}
else {
var p = $.property({initial: v}); g = p.getter(); s = p.setter();
p = $.property({initial: v}); g = p.getter(); s = p.setter();
}
g.pname = s.pname = k;
@ -314,8 +326,7 @@ var console;
i++
}
namespace.proxies.__context = this;
return namespace.proxies;
return namespace.$(this);
}
/**
@ -364,7 +375,12 @@ var console;
/**
* Warning level. Set to a higher level to get warnings dumped to console.
*/
warningLevel: 0
warningLevel: 0,
/**
* These events need the live-extensions plugin
*/
event_needs_extensions: { mouseenter: true, mouseleave: true, change: true, focusin: true, focusout: true }
}
var check_id = null;

2
thirdparty/jquery-selector/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
vendor/
test/

View File

@ -0,0 +1,8 @@
---
format: 1
handler:
commit: 2d129e2754ba864a5c538c3be3355e24f49f1939
branch: master
lock: false
repository_url: git://github.com/hafriedlander/jquery.selector.git
repository_class: Piston::Git::Repository

10
thirdparty/jquery-selector/LICENSE vendored Normal file
View File

@ -0,0 +1,10 @@
Copyright (C) 2009 Hamish Friedlander (hamish@silverstripe.com) and SilverStripe Limited (www.silverstripe.com)
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of Hamish Friedlander nor SilverStripe nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View File

@ -0,0 +1,32 @@
h1. jQuery Selector
h3. Selector tools and reverse mapping for jQuery
* Parse and examine the AST for a selector
* Calculate the specifity of a selector
* Determine if a single element matches a selector ($().is equivilent) much faster that jQuery
h3. Intro
jQuery has an excellent CSS 3 selector engine built in called Sizzle. However, it's clear focus is on filtering a set of elements down to the set that matches a selector.
jQuery.concrete has a usage pattern quite different from that optimized for by Sizzle. It reuses a small set of selectors (making a more complicated initial parsing step acceptable)
and checks if a single element matches those selectors. In this case, Sizzle can be quite slow.
h3. Usage
Usual usage of jQuery selector:
var sel = $.selector('#foo');
sel.matches(element);
element must be a raw DOM object, not a jQuery element, sequence of elements or anything else
h3. Compatibility
jQuery.selector aims to be 100% compatible with Sizzle (except a couple of corner cases, noted below). Sizzle implements most of the CSS 3 spec plus several extensions.
One set of extensions Sizzle has is a set of pseudo-classes that filter the currently selected set. These pseudo-classes are ':first', ':last', ':even', ':odd', ':eq', ':nth', ':lt', ':gt'.
These pseudo-classes are not supported in jQuery.selector, as they don't make sense when the working set is always a single element.
jQuery.selector currently passes the jQuery selector unit test suite, with the exception of the psuedo-classes mentioned above