eve 0.5.0 → 0.5.4

package/.npmignore

@@ -0,0 +1,2 @@
+
+node_modules

package/README.md

@@ -2,4 +2,145 @@
 
 Tiny event helping JavaScript library.
 
-For use case look at e.html
+## eve(name, scope, varargs)
+Fires event with given `name`, given scope and other parameters.
+
+### Parameters
+- _name_  **string**
+    name of the _event_, dot (`.`) or slash (`/`) separated
+- _scope_  **object**
+    context for the event handlers
+- _varargs_  **...**
+    the rest of arguments will be sent to event handlers
+
+**Returns:**  **object** array of returned values from the listeners. Array has two methods `.firstDefined()` and `.lastDefined()` to get first or last not `undefined` value.
+
+## eve.listeners(name)
+Internal method which gives you array of all event handlers that will be triggered by the given `name`.
+
+### Parameters
+- _name_  **string**
+    name of the event, dot (`.`) or slash (`/`) separated
+
+**Returns:**  **array** array of event handlers
+
+## eve.separator(separator)
+If for some reasons you don’t like default separators (`.` or `/`) you can specify yours
+here. Be aware that if you pass a string longer than one character it will be treated as
+a list of characters.
+
+### Parameters
+- _separator_  **string**
+    new separator. Empty string resets to default: `.` or `/`.
+
+
+## eve.on(name, f, name, f)
+Binds given event handler with a given name. You can use wildcards “`*`” for the names:
+
+```js
+eve.on("*.under.*", f);
+eve("mouse.under.floor"); // triggers f
+```
+Use <a href="#eve" class="dr-link">eve</a> to trigger the listener.
+
+### Parameters
+- _name_  **string**
+    name of the event, dot (`.`) or slash (`/`) separated, with optional wildcards
+- _f_  **function**
+    event handler function
+- _name_  **array**
+    if you don’t want to use separators, you can use array of strings
+- _f_  **function**
+    event handler function
+
+**Returns:**  **function** returned function accepts a single numeric parameter that represents z-index of the handler. It is an optional feature and only used when you need to ensure that some subset of handlers will be invoked in a given order, despite of the order of assignment.
+
+### Example:
+```js
+eve.on("mouse", eatIt)(2);
+eve.on("mouse", scream);
+eve.on("mouse", catchIt)(1);
+```
+This will ensure that `catchIt` function will be called before `eatIt`.
+
+If you want to put your handler before non-indexed handlers, specify a negative value.
+Note: I assume most of the time you don’t need to worry about z-index, but it’s nice to have this feature “just in case”.
+
+
+## eve.f(event, varargs)
+Returns function that will fire given event with optional arguments.
+Arguments that will be passed to the result function will be also
+concated to the list of final arguments.
+
+```js
+el.onclick = eve.f("click", 1, 2);
+eve.on("click", function (a, b, c) {
+    console.log(a, b, c); // 1, 2, [event object]
+});
+```
+### Parameters
+- _event_  **string**
+    event name
+- _varargs_  **…**
+    and any other arguments
+
+**Returns:**  **function** possible event handler function
+
+## eve.stop()
+Is used inside an event handler to stop the event, preventing any subsequent listeners from firing.
+
+
+## eve.nt([subname])
+Could be used inside event handler to figure out actual name of the event.
+
+### Parameters
+- _subname_  **string**
+    subname of the event
+
+**Returns:**  **string** name of the event, if `subname` is not specified
+or
+
+**Returns:**  **boolean** `true`, if current event’s name contains `subname`
+
+## eve.nts()
+Could be used inside event handler to figure out actual name of the event.
+
+**Returns:**  **array** names of the event
+
+## eve.off(name, f)
+Removes given function from the list of event listeners assigned to given name.
+If no arguments specified all the events will be cleared.
+
+### Parameters
+- _name_  **string**
+    name of the event, dot (`.`) or slash (`/`) separated, with optional wildcards
+- _f_  **function**
+    event handler function
+
+
+## eve.unbind()
+See <a href="#eve.off" class="dr-link">eve.off</a>
+
+
+## eve.once(name, f)
+Binds given event handler with a given name to only run once then unbind itself.
+
+```js
+eve.once("login", f);
+eve("login"); // triggers f
+eve("login"); // no listeners
+```
+Use <a href="#eve" class="dr-link">eve</a> to trigger the listener.
+
+### Parameters
+- _name_  **string**
+    name of the event, dot (`.`) or slash (`/`) separated, with optional wildcards
+- _f_  **function**
+    event handler function
+
+**Returns:**  **function** same return function as <a href="#eve.on" class="dr-link">eve.on</a>
+
+## eve.version()
+Current version of the library.
+
+

package/component.json

@@ -2,7 +2,7 @@
   "name": "eve",
   "repo": "adobe-webplatform/eve",
   "description": "Custom Events",
-  "version": "0.5.0",
+  "version": "0.5.4",
   "keywords": ["events"],
   "dependencies": {},
   "development": {},

package/dr.json

@@ -0,0 +1,10 @@
+{
+    "title": "Eve",
+    "output": "README.md",
+    "template": "template.dot",
+    "css": "custom",
+    "files": [{
+        "url": "eve.js",
+        "link": "https://github.com/adobe-webplatform/eve/blob/master/eve.js"
+    }]
+}

package/eve.js

@@ -1,29 +1,28 @@
-// Copyright (c) 2013 Adobe Systems Incorporated. All rights reserved.
-// 
+// Copyright (c) 2017 Adobe Systems Incorporated. All rights reserved.
+//
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
-// 
+//
 // http://www.apache.org/licenses/LICENSE-2.0
-// 
+//
 // Unless required by applicable law or agreed to in writing, software
 // distributed under the License is distributed on an "AS IS" BASIS,
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
 // ┌────────────────────────────────────────────────────────────┐ \\
-// │ Eve 0.5.0 - JavaScript Events Library                      │ \\
+// │ Eve 0.5.4 - JavaScript Events Library                      │ \\
 // ├────────────────────────────────────────────────────────────┤ \\
 // │ Author Dmitry Baranovskiy (http://dmitry.baranovskiy.com/) │ \\
 // └────────────────────────────────────────────────────────────┘ \\
 
 (function (glob) {
-    var version = "0.5.0",
+    var version = "0.5.4",
         has = "hasOwnProperty",
         separator = /[\.\/]/,
         comaseparator = /\s*,\s*/,
         wildcard = "*",
-        fun = function () {},
         numsort = function (a, b) {
             return a - b;
         },
@@ -49,15 +48,13 @@
         Str = String,
         isArray = Array.isArray || function (ar) {
             return ar instanceof Array || objtos.call(ar) == "[object Array]";
-        };
+        },
     /*\
      * eve
      [ method ]
 
      * Fires event with given `name`, given scope and other parameters.
 
-     > Arguments
-
      - name (string) name of the *event*, dot (`.`) or slash (`/`) separated
      - scope (object) context for the event handlers
      - varargs (...) the rest of arguments will be sent to event handlers
@@ -65,18 +62,15 @@
      = (object) array of returned values from the listeners. Array has two methods `.firstDefined()` and `.lastDefined()` to get first or last not `undefined` value.
     \*/
         eve = function (name, scope) {
-            var e = events,
-                oldstop = stop,
+            var oldstop = stop,
                 args = Array.prototype.slice.call(arguments, 2),
                 listeners = eve.listeners(name),
                 z = 0,
-                f = false,
                 l,
                 indexed = [],
                 queue = {},
                 out = [],
-                ce = current_event,
-                errors = [];
+                ce = current_event;
             out.firstDefined = firstDefined;
             out.lastDefined = lastDefined;
             current_event = name;
@@ -126,16 +120,14 @@
             current_event = ce;
             return out;
         };
-        // Undocumented. Debug only.
-        eve._events = events;
+    // Undocumented. Debug only.
+    eve._events = events;
     /*\
      * eve.listeners
      [ method ]
 
      * Internal method which gives you array of all event handlers that will be triggered by the given `name`.
 
-     > Arguments
-
      - name (string) name of the event, dot (`.`) or slash (`/`) separated
 
      = (array) array of event handlers
@@ -205,7 +197,7 @@
      - name (array) if you don’t want to use separators, you can use array of strings
      - f (function) event handler function
      **
-     = (function) returned function accepts a single numeric parameter that represents z-index of the handler. It is an optional feature and only used when you need to ensure that some subset of handlers will be invoked in a given order, despite of the order of assignment. 
+     = (function) returned function accepts a single numeric parameter that represents z-index of the handler. It is an optional feature and only used when you need to ensure that some subset of handlers will be invoked in a given order, despite of the order of assignment.
      > Example:
      | eve.on("mouse", eatIt)(2);
      | eve.on("mouse", scream);
@@ -219,7 +211,7 @@
         if (typeof f != "function") {
             return function () {};
         }
-        var names = isArray(name) ? (isArray(name[0]) ? name : [name]) : Str(name).split(comaseparator);
+        var names = isArray(name) ? isArray(name[0]) ? name : [name] : Str(name).split(comaseparator);
         for (var i = 0, ii = names.length; i < ii; i++) {
             (function (name) {
                 var names = isArray(name) ? name : Str(name).split(separator),
@@ -254,7 +246,6 @@
      | eve.on("click", function (a, b, c) {
      |     console.log(a, b, c); // 1, 2, [event object]
      | });
-     > Arguments
      - event (string) event name
      - varargs (…) and any other arguments
      = (function) possible event handler function
@@ -280,8 +271,6 @@
      **
      * Could be used inside event handler to figure out actual name of the event.
      **
-     > Arguments
-     **
      - subname (string) #optional subname of the event
      **
      = (string) name of the event, if `subname` is not specified
@@ -314,8 +303,6 @@
      * Removes given function from the list of event listeners assigned to given name.
      * If no arguments specified all the events will be cleared.
      **
-     > Arguments
-     **
      - name (string) name of the event, dot (`.`) or slash (`/`) separated, with optional wildcards
      - f (function) event handler function
     \*/
@@ -330,7 +317,7 @@
             eve._events = events = {n: {}};
             return;
         }
-        var names = isArray(name) ? (isArray(name[0]) ? name : [name]) : Str(name).split(comaseparator);
+        var names = isArray(name) ? isArray(name[0]) ? name : [name] : Str(name).split(comaseparator);
         if (names.length > 1) {
             for (var i = 0, ii = names.length; i < ii; i++) {
                 eve.off(names[i], f);
@@ -342,7 +329,8 @@
             key,
             splice,
             i, ii, j, jj,
-            cur = [events];
+            cur = [events],
+            inodes = [];
         for (i = 0, ii = names.length; i < ii; i++) {
             for (j = 0; j < cur.length; j += splice.length - 2) {
                 splice = [j, 1];
@@ -350,10 +338,18 @@
                 if (names[i] != wildcard) {
                     if (e[names[i]]) {
                         splice.push(e[names[i]]);
+                        inodes.unshift({
+                            n: e,
+                            name: names[i]
+                        });
                     }
                 } else {
                     for (key in e) if (e[has](key)) {
                         splice.push(e[key]);
+                        inodes.unshift({
+                            n: e,
+                            name: key
+                        });
                     }
                 }
                 cur.splice.apply(cur, splice);
@@ -387,6 +383,20 @@
                 e = e.n;
             }
         }
+        // prune inner nodes in path
+        prune: for (i = 0, ii = inodes.length; i < ii; i++) {
+            e = inodes[i];
+            for (key in e.n[e.name].f) {
+                // not empty (has listeners)
+                continue prune;
+            }
+            for (key in e.n[e.name].n) {
+                // not empty (has children)
+                continue prune;
+            }
+            // is empty
+            delete e.n[e.name];
+        }
     };
     /*\
      * eve.once
@@ -398,8 +408,6 @@
      | eve("login"); // no listeners
      * Use @eve to trigger the listener.
      **
-     > Arguments
-     **
      - name (string) name of the event, dot (`.`) or slash (`/`) separated, with optional wildcards
      - f (function) event handler function
      **
@@ -422,5 +430,6 @@
     eve.toString = function () {
         return "You are running Eve " + version;
     };
-    (typeof module != "undefined" && module.exports) ? (module.exports = eve) : (typeof define === "function" && define.amd ? (define("eve", [], function() { return eve; })) : (glob.eve = eve));
-})(this);
+    glob.eve = eve;
+    typeof module != "undefined" && module.exports ? module.exports = eve : typeof define === "function" && define.amd ? define("eve", [], function () { return eve; }) : glob.eve = eve;
+})(typeof window != "undefined" ? window : this);

package/package.json

@@ -7,12 +7,67 @@
         "url"   : "http://dmitry.baranovskiy.com"
     },
 	"description" : "Simple custom events",
-    "version" : "0.5.0",
+    "license": "Apache-2.0",
+    "version" : "0.5.4",
 
     "main"    : "./eve.js",
 
+    "devDependencies": {
+        "mocha": "*",
+        "expect.js": "*",
+        "eslint": "*",
+        "dr.js": "~0.1.0"
+    },
+
+    "scripts": {
+        "test": "eslint eve.js",
+        "build": "node node_modules/dr.js/dr dr.json"
+    },
+
     "repository": {
         "type": "git",
         "url": "git@github.com:adobe-webplatform/eve.git"
+    },
+
+    "eslintConfig": {
+        "globals": {
+            "window": true,
+            "console": true
+        },
+        "rules": {
+            "block-scoped-var": 0,
+            "comma-dangle": 0,
+            "no-extra-parens": 1,
+            "no-shadow": 0,
+            "consistent-return": 0,
+            "eqeqeq": 0,
+            "no-new-wrappers": 0,
+            "no-sequences": 1,
+            "radix": 2,
+            "new-parens": 0,
+            "no-underscore-dangle": 0,
+            "no-path-concat": 0,
+            "strict": 0,
+            "camelcase": 0,
+            "no-extend-native": 0,
+            "no-loop-func": 0,
+            "new-cap": 0,
+            "no-unused-expressions": 0,
+            "no-mixed-requires": 0,
+            "indent": ["error", 4, { "SwitchCase": 1, "VariableDeclarator": 1 }],
+            "no-multi-spaces": [0, {
+              "exceptions": {
+                "VariableDeclarator": true
+              }
+            }],
+            "no-trailing-spaces": [2, { "skipBlankLines": false }],
+            "no-unused-vars": [2, {"vars": "all", "args": "none"}],
+            "space-before-function-paren": [2, {"anonymous": "always", "named": "never"}],
+            "quotes": [
+                1,
+                "double",
+                "avoid-escape"
+            ]
+        }
     }
 }

package/template.dot

@@ -0,0 +1,13 @@
+# Eve
+
+Tiny event helping JavaScript library.
+{{~it.out :item:index}}
+## {{=item[0].name}}
+{{~item :line:i}}{{ if (i > 0) { }}{{ if (line.text) { }}{{=line.text.join("\n").replace(/<\/?code>/g, "`").replace(/<\/?em>/g, "_")}}{{ } }}{{ if (line.attr) { }}### Parameters
+{{~line.attr :attr:j}}- _{{=attr.name}}_ {{~attr.type :type:k}} **{{=type}}**{{~}}
+    {{=attr.desc.replace(/<\/?code>/g, "`").replace(/<\/?em>/g, "_")}}
+{{~}}{{ } }}{{ if (line.html) { }}{{=line.html.replace(/<\/?code>/g, "`").replace(/<\/?em>/g, "_")}}{{ } }}{{ if (line.head) { }}
+### {{=line.head}}{{ } }}{{ if (line.code) { }}```js
+{{=line.code.join("\n")}}
+```{{ } }}{{ if (line.rtrn) { }}**Returns:** {{~line.rtrn.type :type:k}} **{{=type}}**{{~}} {{=line.rtrn.desc.replace(/<\/?code>/g, "`").replace(/<\/?em>/g, "_")}}{{ } }}
+{{ } }}{{~}}{{~}}