cahnory / jquery.easyplug Goto Github PK

Each plugin made with easyPlug has three predefined methods attached to the Class object :

• getName: return the plugin index on which is attached to the jQuery object.
• space: add plugin namespace to an events string. (eg: "foo bar" become "foo.pluginNamespace bar.pluginNamespace")
• prefix: add plugin prefix for custom events, data indexes,… (eg "foo bar" become "pluginPrefix-foo pluginPrefix-bar")

As getName seems to be a good name, space and prefix are too vague. Better names have to be found before this branch become the master one.

The reason I use a prefix instead of namespace for custom event is to prevent collision between events. If I use namespace we can't differentiate:
load.ns: plugin binding on load event
from:
load.ns: plugin custom event "load"

It could result in such case:

// Plugin bind on std load event
el.on('load.ns', function () {
  // Do some stuff then trigger custom event
  el.trigger('load.ns'); // loop
});

I agree that it could be avoid by defining a guideline but it's something I want to avoid.

The best way to use custom event is, until now:

$(elements).on(Plugin.events.customEventName, function () {});

I'm considering adding a new method to the Plugin object:

$(elements).on(Plugin.getEvent(customEventString), function () {});

The main goal is to ease the use of namespaced and/or multiple custom events.

You have signified that you have some intervention of qunit in your bower.json. So why not to dev some unit tests ? ;)

Suggestion : use karma + qunit + istanbul to do it. You will have automated tests, easy to write tests and code coverage report. If I have time, I will make a pull request this day to show you how to start.

Cheers !

It could be usefull to be able to define a function called when no element is matched. Or maybe only when no element were passed to the jQuery function.