compute-io · Planeshifter · May 24, 2015 · May 24, 2015 · May 24, 2015 · May 24, 2015
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.jshintignore b/.jshintignore
@@ -0,0 +1,14 @@
+
+# Directories #
+###############
+build/
+reports/
+dist/
+
+# Node.js #
+###########
+/node_modules/
+
+# Git #
+#######
+.git*
diff --git a/.jshintrc b/.jshintrc
@@ -0,0 +1,71 @@
+{
+	"bitwise": false,
+	"camelcase": false,
+	"curly": true,
+	"eqeqeq": true,
+	"es3": false,
+	"forin": true,
+	"freeze": true,
+	"immed": true,
+	"indent": 4,
+	"latedef": "nofunc",
+	"newcap": true,
+	"noarg": true,
+	"noempty": false,
+	"nonbsp": true,
+	"nonew": true,
+	"plusplus": false,
+	"quotmark": "single",
+	"undef": true,
+	"unused": true,
+	"strict": true,
+	"maxparams": 10,
+	"maxdepth": 5,
+	"maxstatements": 100,
+	"maxcomplexity": false,
+	"maxlen": 1000,
+	"asi": false,
+	"boss": false,
+	"debug": false,
+	"eqnull": false,
+	"esnext": false,
+	"evil": false,
+	"expr": false,
+	"funcscope": false,
+	"globalstrict": false,
+	"iterator": false,
+	"lastsemic": false,
+	"laxbreak": false,
+	"laxcomma": false,
+	"loopfunc": false,
+	"maxerr": 1000,
+	"moz": false,
+	"multistr": false,
+	"notypeof": false,
+	"proto": false,
+	"scripturl": false,
+	"shadow": false,
+	"sub": true,
+	"supernew": false,
+	"validthis": false,
+	"noyield": false,
+	"browser": true,
+	"browserify": true,
+	"couch": false,
+	"devel": true,
+	"dojo": false,
+	"jasmine": false,
+	"jquery": false,
+	"mocha": true,
+	"mootools": false,
+	"node": true,
+	"nonstandard": false,
+	"prototypejs": false,
+	"qunit": false,
+	"rhino": false,
+	"shelljs": false,
+	"worker": false,
+	"wsh": false,
+	"yui": false,
+	"globals": {}
+}
diff --git a/.npmignore b/.npmignore
@@ -13,6 +13,7 @@ examples/
 reports/
 support/
 test/
+benchmark/
 
 # Node.js #
 ###########
@@ -46,4 +47,6 @@ Desktop.ini
 # Utilities #
 #############
 .jshintrc
-.travis.yml
+.jshintignore
+.travis.yml
+.editorconfig
diff --git a/.travis.yml b/.travis.yml
@@ -1,5 +1,12 @@
 language: node_js
 node_js:
-  - "0.10"
+  - '0.12'
+  - '0.11'
+  - '0.10'
+  - '0.8'
+  - 'iojs'
+before_install:
+  - npm update -g npm
 after_script:
-  - npm run coveralls
+  - npm run coveralls
+
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Athan Reines.
+Copyright (c) 2014-2015 The Compute.io Authors. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/Makefile b/Makefile
@@ -5,32 +5,42 @@
 # Set the node.js environment to test:
 NODE_ENV ?= test
 
+# Kernel name:
+KERNEL ?= $(shell uname -s)
+
+ifeq ($(KERNEL), Darwin)
+	OPEN ?= open
+else
+	OPEN ?= xdg-open
+endif
 
 # NOTES #
 
-NOTES ?= 'TODO|FIXME'
+NOTES ?= 'TODO|FIXME|WARNING|HACK|NOTE'
 
 
 # MOCHA #
 
-# Specify the test framework bin locations:
 MOCHA ?= ./node_modules/.bin/mocha
 _MOCHA ?= ./node_modules/.bin/_mocha
-
-# Specify the mocha reporter:
 MOCHA_REPORTER ?= spec
 
 
 # ISTANBUL #
 
-# Istanbul configuration:
 ISTANBUL ?= ./node_modules/.bin/istanbul
 ISTANBUL_OUT ?= ./reports/coverage
 ISTANBUL_REPORT ?= lcov
 ISTANBUL_LCOV_INFO_PATH ?= $(ISTANBUL_OUT)/lcov.info
 ISTANBUL_HTML_REPORT_PATH ?= $(ISTANBUL_OUT)/lcov-report/index.html
 
 
+# JSHINT #
+
+JSHINT ?= ./node_modules/.bin/jshint
+JSHINT_REPORTER ?= ./node_modules/jshint-stylish/stylish.js
+
+
 
 # FILES #
 
@@ -81,7 +91,8 @@ test-istanbul-mocha: node_modules
 	NODE_ENV=$(NODE_ENV) \
 	NODE_PATH=$(NODE_PATH_TEST) \
 	$(ISTANBUL) cover \
-	--dir $(ISTANBUL_OUT) --report $(ISTANBUL_REPORT) \
+		--dir $(ISTANBUL_OUT) \
+		--report $(ISTANBUL_REPORT) \
 	$(_MOCHA) -- \
 		--reporter $(MOCHA_REPORTER) \
 		$(TESTS)
@@ -95,9 +106,20 @@ test-istanbul-mocha: node_modules
 view-cov: view-istanbul-report
 
 view-istanbul-report:
-	open $(ISTANBUL_HTML_REPORT_PATH)
+	$(OPEN) $(ISTANBUL_HTML_REPORT_PATH)
 
 
+# LINT #
+
+.PHONY: lint lint-jshint
+
+lint: lint-jshint
+
+lint-jshint: node_modules
+	$(JSHINT) \
+		--reporter $(JSHINT_REPORTER) \
+		./
+
 
 # NODE #
 
@@ -116,7 +138,6 @@ clean-node:
 
 
 # CLEAN #
-
 .PHONY: clean
 
 clean:

diff --git a/README.md b/README.md
@@ -16,16 +16,52 @@ For use in the browser, use [browserify](https://github.com/substack/node-browse
 
 ## Usage
 
-To use the module,
 
 ``` javascript
 var mode = require( 'compute-mode' );
 ```
 
+#### mode( arr[, accessor] )
+
+Returns the mode of the values in the input `array`.
+
+``` javascript
+var data = [ 3, 2, 5, 2, 5 ];
+
+var m = mode( data );
+// returns [2, 5]
+```
+
+The function returns a sorted `array` holding all modes in increasing order.
+
+For non-numeric `arrays`, provide an accessor `function` for accessing `numeric` values.
+
+``` javascript
+var arr = [
+	{'x':3},
+	{'x':2},
+	{'x':5},
+	{'x':2},
+	{'x':5}
+];
+
+function getValue( d ) {
+	return d.x;
+}
+
+var m = mode( arr, getValue );
+// returns [2,5]
+```
+
+
+__Note__: if provided an empty `array`, the function returns `null`.
+
 
 ## Examples
 
 ``` javascript
+var mode = require( 'compute-mode' );
+
 var data = new Array( 100 );
 
 for ( var i = 0; i < data.length; i++ ) {
@@ -43,16 +79,11 @@ $ node ./examples/index.js
 ```
 
 
-## Notes
-
-This method will return a sorted `array`.
-
-
 ## Tests
 
 ### Unit
 
-Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
+Unit tests use the [Mocha](http://mochajs.org) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
 
 ``` bash
 $ make test
@@ -72,19 +103,19 @@ $ make test-cov
 Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
 
 ``` bash
-$ open reports/coverage/lcov-report/index.html
+$ make view-cov
 ```
 
 
+---
 ## License
 
-[MIT license](http://opensource.org/licenses/MIT). 
+[MIT license](http://opensource.org/licenses/MIT).
 
 
----
 ## Copyright
 
-Copyright &copy; 2014. Athan Reines.
+Copyright &copy; 2014-2015. The Compute.io Authors.
 
 
 [npm-image]: http://img.shields.io/npm/v/compute-mode.svg
@@ -103,4 +134,4 @@ Copyright &copy; 2014. Athan Reines.
 [dev-dependencies-url]: https://david-dm.org/dev/compute-io/mode
 
 [github-issues-image]: http://img.shields.io/github/issues/compute-io/mode.svg
-[github-issues-url]: https://github.com/compute-io/mode/issues
+[github-issues-url]: https://github.com/compute-io/mode/issues
diff --git a/examples/index.js b/examples/index.js
@@ -1,3 +1,5 @@
+'use strict';
+
 var mode = require( './../lib' );
 
 var data = new Array( 100 );
@@ -7,4 +9,4 @@ for ( var i = 0; i < data.length; i++ ) {
 }
 
 console.log( mode( data )  );
-// Returns [...]
+// Returns [...]