Initial commit.

Author: Guille Paz

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+node_modules
+dist

.jshintrc

@@ -0,0 +1,24 @@
+{
+  "bitwise": false,
+  "curly": true,
+  "eqeqeq": true,
+  "expr": true,
+  "forin": true,
+  "freeze": true,
+  "funcscope": true,
+  "globalstrict": true,
+  "nonbsp": true,
+  "unused": true,
+  "debug": true,
+  "evil": true,
+  "lastsemic": true,
+  "loopfunc": true,
+  "proto": true,
+  "scripturl": true,
+  "strict": true,
+  "browser": true,
+  "browserify": true,
+  "node": true,
+  "esnext": true,
+  "validthis": true
+}

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+## Code style
+Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.**
+
+## Modifying the code
+
+Please don't edit `/dist/emitter.js` and `/dist/emitter.min.js` files. You'll find source code in the `index.js` file.
+
+1. Fork and clone the repo.
+2. Run `npm install` to install all dependencies.
+3. Create a new branch, please don't work in your `master` branch directly.
+4. Code!
+
+### Running the tests
+
+- Run `npm test` from your command line and check the console.
+
+## Pull requests
+
+1. Create a new branch, **please don't work in your `master` branch directly**.
+2. Code!
+3. Update the tests and run `npm test` to see the tests.
+4. Run `npm run hint`.
+5. Run `npm run dist` to build a new version.
+6. Update the documentation and package to reflect any changes.
+7. Push to your fork and submit a pull request.

README.md

@@ -1,2 +1,103 @@
 # emitter
-A JavaScript event emitter written in ES6.
+
+> A JavaScript Emitter written in ES6.
+
+## Usage
+```js
+import Emitter from 'Emitter';
+
+let bus = new Emitter();
+
+bus.emit('finish');
+
+```
+
+```js
+import Emitter from 'Emitter';
+
+class Foo extends Emitter {
+  constructor() {
+    // Code here!
+  }
+
+  ...
+};
+
+let foo = new Foo();
+
+foo.emit('finish');
+```
+
+## API
+
+### Emitter#on(event, listener)
+Adds a `listener` to the collection for a specified `event`.
+- `event` - The name of the event you want to add.
+- `listener` - Listener you want to add from given event.
+
+```js
+emitter.on('live', listener);
+```
+
+### Emitter#once(event, listener)
+Adds a one time `listener` to the collection for a specified `event`. It will execute only once.
+- `event` - The name of the event.
+- `listener` - Listener you want to add from the given event.
+
+```js
+emitter.once('live', listener);
+```
+
+### Emitter#off(event, listener)
+Removes a `listener` from the collection for a specified `event`.
+- `event` - The name of the event.
+- `listener` - Listener you want to remove from the given event.
+
+```js
+emitter.off('live', listener);
+```
+
+### Emitter#removeAllListeners(event)
+Removes all `listeners` from the collection for a specified `event`.
+- `event` - The name of the event you want to remove.
+
+```js
+emitter.removeAllListeners('live');
+```
+
+### Emitter#listeners(event)
+Returns all `listeners` from the collection for a specified `event`.
+- `event` - The name of the event.
+
+```js
+emitter.listeners('live');
+```
+
+### Emitter#emit(event, [arg1], [arg2], [...])
+Execute each of the `listeners` collection in order with the given parameters.
+- `event` - The name of the event you want to emit.
+- `[args, ...]` - The given arguments.
+
+```js
+emitter.emit('live', 'data1', 'data2');
+```
+
+## npm-scripts
+```
+$ npm run build
+```
+
+```
+$ npm run dist
+```
+
+```
+$ npm test
+```
+
+```
+$ npm run hint
+```
+
+## License
+MIT license. Copyright © 2015 [Mango](http://getmango.com).

browserify.js

@@ -0,0 +1,16 @@
+'use strict';
+
+var fs = require('fs');
+var browserify = require('browserify');
+var babelify = require('babelify');
+
+if (!fs.existsSync('./dist')) {
+  fs.mkdirSync('./dist');
+}
+
+browserify({'debug': true, 'standalone': 'Emitter'})
+  .transform(babelify)
+  .require('./index.js', {'entry': true})
+  .bundle()
+  .on('error', function (err) { console.log('Error : ' + err.message); })
+  .pipe(fs.createWriteStream('dist/build.js'));

index.js

@@ -0,0 +1,133 @@
+'use strict';
+
+/**
+ * Creates a new instance of Emitter.
+ * @class
+ * @returns {Object} Returns a new instance of Emitter.
+ * @example
+ * // Creates a new instance of Emitter.
+ * var Emitter = require('emitter');
+ *
+ * var emitter = new Emitter();
+ */
+class Emitter {
+
+  /**
+   * Adds a listener to the collection for the specified event.
+   * @memberof! Emitter.prototype
+   * @function
+   * @param {String} event - The event name.
+   * @param {Function} listener - A listener function to add.
+   * @returns {Object} Returns an instance of Emitter.
+   * @example
+   * // Add an event listener to "foo" event.
+   * emitter.on('foo', listener);
+   */
+  on(event, listener) {
+    // Use the current collection or create it.
+    this._eventCollection = this._eventCollection || {};
+
+    // Use the current collection of an event or create it.
+    this._eventCollection[event] = this._eventCollection[event] || [];
+
+    // Appends the listener into the collection of the given event
+    this._eventCollection[event].push(listener);
+
+    return this;
+  }
+
+  /**
+   * Adds a listener to the collection for the specified event that will be called only once.
+   * @memberof! Emitter.prototype
+   * @function
+   * @param {String} event - The event name.
+   * @param {Function} listener - A listener function to add.
+   * @returns {Object} Returns an instance of Emitter.
+   * @example
+   * // Will add an event handler to "foo" event once.
+   * emitter.once('foo', listener);
+   */
+  once(event, listener) {
+    const self = this;
+
+    function fn() {
+      self.off(event, fn);
+      listener.apply(this, arguments);
+    }
+
+    fn.listener = listener;
+
+    this.on(event, fn);
+
+    return this;
+  }
+
+  /**
+   * Removes a listener from the collection for the specified event.
+   * @memberof! Emitter.prototype
+   * @function
+   * @param {String} event - The event name.
+   * @param {Function} listener - A listener function to remove.
+   * @returns {Object} Returns an instance of Emitter.
+   * @example
+   * // Remove a given listener.
+   * emitter.off('foo', listener);
+   */
+  off(event, listener) {
+
+    let listeners;
+
+    // Defines listeners value.
+    if (!this._eventCollection || !(listeners = this._eventCollection[event])) {
+      return this;
+    }
+
+    listeners.forEach(function(fn, i) {
+      if (fn === listener || fn.listener === listener) {
+        // Removes the given listener.
+        listeners.splice(i, 1);
+        return;
+      }
+    });
+
+    // Removes an empty event collection.
+    if (listeners.length === 0) {
+      delete this._eventCollection[event];
+    }
+
+    return this;
+  }
+
+  /**
+   * Execute each item in the listener collection in order with the specified data.
+   * @memberof! Emitter.prototype
+   * @function
+   * @param {String} event - The name of the event you want to emit.
+   * @param {...Object} data - Data to pass to the listeners.
+   * @returns {Object} Returns an instance of Emitter.
+   * @example
+   * // Emits the "foo" event with 'param1' and 'param2' as arguments.
+   * emitter.emit('foo', 'param1', 'param2');
+   */
+  emit(event, ...args) {
+    let listeners;
+
+    // Defines listeners value.
+    if (!this._eventCollection || !(listeners = this._eventCollection[event])) {
+      return this;
+    }
+
+    // Clone listeners
+    listeners = listeners.slice(0);
+
+    listeners.forEach(fn => fn.apply(this, args));
+
+    return this;
+  }
+
+}
+
+/**
+ * Exports Emitter
+ */
+export default Emitter;

package.json

@@ -0,0 +1,28 @@
+{
+  "name": "emitter",
+  "repository": "git@github.com:mango/emitter.git",
+  "description": "A JavaScript event emitter written in ES6.",
+  "author": "Guille Paz <guille87paz@gmail.com>",
+  "version": "0.0.1",
+  "scripts": {
+    "build": "node browserify.js",
+    "test": "npm run build && node_modules/.bin/_mocha",
+    "dist": "node browserify.js && uglifyjs ./dist/emitter.js -m -o ./dist/emitter.min.js",
+    "hint": "jshint index.js"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "better-assert": "1.0.2",
+    "browserify": "7.0.3",
+    "mocha": "2.1.0",
+    "uglify-js": "2.4.15",
+    "jshint": "2.6.3",
+    "babelify": "^5.0.4",
+    "babel": "^4.7.13"
+  },
+  "main": "index.js",
+  "keywords": [
+    "emitter"
+  ],
+  "license": "MIT"
+}