array-kit 0.2.5 → 0.2.7

package/lib/array-kit.js

@@ -38,6 +38,9 @@ const arrayKit = {
 
 module.exports = arrayKit ;
 
+arrayKit.randomInteger = ( min , max ) => min + Math.floor( ( max - min + 1 ) * Math.random() ) ;
+
 arrayKit.random = arrayKit.randomElement = array => array[ Math.floor( array.length * Math.random() ) ] ;
 arrayKit.shuffle = array => arrayKit.sample( array , array.length , true ) ;
+arrayKit.randomSampleSize = ( array , min , max , inPlace ) => arrayKit.sample( array , arrayKit.randomInteger( min , max ) , inPlace ) ;
 

package/lib/delete.js

@@ -38,7 +38,7 @@
 module.exports = ( src , index ) => {
 	if ( index >= src.length ) { return ; }
 
-	var iMax = src.length - 2 ;
+	const iMax = src.length - 2 ;
 
 	while ( index <= iMax ) {
 		src[ index ] = src[ index + 1 ] ;

package/lib/deleteValue.js

@@ -37,7 +37,7 @@
 	* value: the value to delete
 */
 module.exports = ( src , value ) => {
-	var currentValue , deletedCount ,
+	let currentValue ,
 		i = 0 ,
 		j = 0 ;
 
@@ -54,7 +54,7 @@ module.exports = ( src , value ) => {
 		i ++ ;
 	}
 
-	deletedCount = src.length - j ;
+	const deletedCount = src.length - j ;
 	src.length = j ;
 
 	return deletedCount ;

package/lib/inPlaceFilter.js

@@ -37,11 +37,12 @@
 		* index the index of the current element
 		* the array
 	* thisArg: what is used as `this` inside the callback function
-	* forceKey: for that key instead of the index of the current element (useful for other libs)
+	* forceKey: force that key instead of the index of the current element (useful for other libs)
 */
 module.exports = ( src , fn , thisArg , forceKey ) => {
-	var hasForcedKey = arguments.length >= 4 ,
-		value ,
+	const hasForcedKey = arguments.length >= 4 ;
+
+	let value ,
 		i = 0 ,
 		j = 0 ;
 

package/lib/range.js

@@ -31,33 +31,46 @@
 /*
 	Create an array.
 
-	.range( [start] , end , [step] ), where:
+	.range( length )
+	.range( start , end )
+	.range( start , end , step )
+	.range( [start] , end , [step] )
 
+	* length `number` the length of the array
 	* start `number` (default: 0) the value of the first item
 	* end `number` the values end at this number (excluded)
 	* step `number` (default: 1) the value of the increment
 */
 module.exports = function( start , end , step ) {
-	if ( ! arguments.length ) { return [] ; }
-
+	// Fast exit / common path first
 	if ( arguments.length === 1 ) {
-		end = start ;
-		start = 0 ;
+		const length = start ;
+		const output = new Array( length ) ;
+		for ( let i = 0 ; i < length ; i ++ ) { output[ i ] = i ; }
+		return output ;
 	}
 
-	if ( ! step ) { step = start <= end ? 1 : -1 ; }
+	if ( ! arguments.length ) { return [] ; }
 
-	if ( ( step > 0 && start >= end ) || ( step < 0 && start <= end ) ) {
-		return [] ;
+	if ( ! step ) {
+		step = start <= end ? 1 : - 1 ;
 	}
 
-	var i = 0 , v = start , output = [] ;
+	const length = Math.ceil( ( end - start ) / step ) ;
+
+	if ( length <= 0 ) { return [] ; }
+
+	const output = new Array( length ) ;
 
 	if ( step > 0 ) {
-		for ( ; v < end ; i ++ , v += step ) { output[ i ] = v ; }
+		for ( let i = 0 , v = start ; v < end ; i ++ , v += step ) {
+			output[ i ] = v ;
+		}
 	}
 	else {
-		for ( ; v > end ; i ++ , v += step ) { output[ i ] = v ; }
+		for ( let i = 0 , v = start ; v > end ; i ++ , v += step ) {
+			output[ i ] = v ;
+		}
 	}
 
 	return output ;

package/lib/sample.js

@@ -36,8 +36,9 @@
 	* inPlace: boolean, true if the array should be shuffled in-place
 */
 module.exports = ( array , count = Infinity , inPlace = false ) => {
-	var currentIndex , randomIndex , temp ,
-		sample = inPlace ? array : [ ... array ] ;
+	const sample = inPlace ? array : Array.from( array ) ;
+
+	let currentIndex , randomIndex , temp ;
 
 	count = Math.max( Math.min( count , array.length ) , 0 ) ;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "array-kit",
-  "version": "0.2.5",
+  "version": "0.2.7",
   "description": "An array manipulation toolbox.",
   "main": "lib/array-kit.js",
   "directories": {

package/.eslintrc.js

@@ -1,168 +0,0 @@
-module.exports = {
-	'root': true ,
-	'env': {
-		'browser': true ,
-		'es6': true ,
-		'node': true
-	} ,
-	'parserOptions': {
-		'ecmaVersion': 2018
-	} ,
-	'extends': [ 'eslint:recommended' ] ,
-	'rules': {
-		
-		/*
-			Bad code -- detect anything that can be broken or lead to bugs
-		*/
-		
-		
-		
-		'strict': [ 'error' , 'global' ] ,
-		'unicode-bom': [ 'error' , 'never' ] ,
-		'radix': 'error' ,
-		'eqeqeq': 'error' ,
-		'consistent-return': 'off' ,
-		'valid-typeof': 'error' ,
-		'no-unneeded-ternary': 'error' ,
-		'no-unused-vars': 'warn' ,	// During development phase, it's boring to clean unused var since they can be used later
-		'no-lonely-if': 'error' ,
-		'no-nested-ternary': 'off' ,	// Now I use the streamlined ternary operator a lot
-		'no-shadow': 'warn' ,
-		'no-shadow-restricted-names': 'error' ,
-		'require-atomic-updates': 'off' ,	// check for possible race condition on assignment, interesting but too nitpicky
-		
-		
-		
-		/*
-			Code preferences
-		*/
-		
-		
-		
-		'prefer-arrow-callback': 'error' ,
-		'prefer-spread': 'warn' ,
-		'prefer-rest-params': 'warn' ,
-		'no-control-regex': 'off' ,	// because thing like \x00 are considered like a control even if escaped...
-		'no-fallthrough': 'off' ,
-		'no-empty': [ 'error' , {
-			'allowEmptyCatch': true
-		} ] ,
-		
-		
-		
-		/*
-			Coding styles -- cosmetic rules and opinionated preferences
-		*/
-		
-		
-		
-		// Indent & spaces (general)
-		'indent': [ 'error' , 'tab' , {
-			'SwitchCase': 1 ,
-			'MemberExpression': 1 ,
-			'flatTernaryExpressions': true
-		} ] ,
-		'newline-per-chained-call': [ 'error', {
-			'ignoreChainWithDepth': 2 
-		} ] ,
-		'no-multi-spaces': 'off' ,
-		'block-spacing': 'error' ,
-		'comma-spacing': [ 'error' , {
-			'before': true ,
-			'after': true
-		} ] ,
-		'no-whitespace-before-property': 'error' ,
-		'space-before-blocks': 'error' ,
-		'space-before-function-paren': [ 'error' , {
-			'anonymous': 'never',
-			'named': 'never',
-			'asyncArrow': 'always'
-		} ] ,
-		'space-infix-ops': 'error' ,
-		'space-unary-ops': [ 'error' , {
-			'words': true ,
-			'nonwords': true ,
-			'overrides': {
-				'-': false ,
-			}
-		} ] ,
-		'space-in-parens': [ 'error' , 'always' , {
-			'exceptions': [ 'empty' ]
-		} ] ,
-		'no-trailing-spaces': 'error' ,
-		'switch-colon-spacing': [ 'error' , {
-			'after': true ,
-			'before': true
-		} ] ,
-		'arrow-spacing': 'error' ,
-		'rest-spread-spacing': [ 'error' , 'always' ] ,
-		/* Troublesome with commented line of code
-		'spaced-comment': [ 'error' , 'always' , {
-			'line': {
-				'markers': [ '/' ],
-				'exceptions': [ '-', '*', '/' ]
-			} ,
-			'block': {
-				'exceptions': [ '*' ] ,
-				'balanced': true
-			}
-		} ] ,
-		*/
-		
-		
-		// Semi-colon
-		'semi': [ 'error' , 'always' ] ,
-		'semi-style': [ 'error' , 'last' ] ,
-		'semi-spacing': [ 'error' , {
-			'before': true ,
-			'after': true
-		} ] ,
-
-		// Objects
-		'key-spacing': [ 'error' , {
-			'beforeColon': false ,
-			'afterColon': true ,
-			'mode': 'strict'
-		} ] ,
-		'object-curly-newline': [ 'error' , {
-			'ObjectExpression' : {
-				'consistent': true ,
-				'minProperties': 4
-			} ,
-			'ObjectPattern' : {
-				// object destructuring assigment
-				'consistent': true ,
-				'minProperties': 8
-			}
-		} ] ,
-		'object-curly-spacing': [ 'error' , 'always' ] ,
-		'object-property-newline': [ 'error' , { 'allowMultiplePropertiesPerLine': true } ] ,
-
-		
-		// Arrays
-		'array-bracket-newline': [ 'error' , 'consistent' ] ,
-		//'array-element-newline': [ 'error' , { 'multiline': true , 'minItems': 5 } ] ,
-		'array-bracket-spacing': [ 'error' , 'always' ],
-		
-		'brace-style': [ 'error' , 'stroustrup' , {
-			'allowSingleLine': true
-		} ] ,
-		
-		
-		// Misc style
-		'no-else-return': 'warn' ,
-		'comma-dangle': [ 'error' , 'never' ] ,
-		'quotes': 'off' ,
-		'camelcase': 'warn' ,
-		
-		
-		
-		/*
-			Method limitation
-		*/
-		
-		
-		
-		'no-console': 'off'
-	}
-} ;

package/Makefile

@@ -1,97 +0,0 @@
-
-
-
-# User rules
-
-# The first rule is the default rule, when invoking "make" without argument...
-# Build every buildable things
-all: install doc
-
-# Just install things so it works, basicaly: it just performs a "npm install --production" ATM
-install: log/npm-install.log
-
-# Just install things so it works, basicaly: it just performs a "npm install" ATM
-dev-install: log/npm-dev-install.log
-
-# This run the JsHint & Mocha BDD test, display it to STDOUT & save it to log/mocha.log and log/jshint.log
-test: log/jshint.log log/mocha.log
-
-# This run the JsHint, display it to STDOUT & save it to log/jshint.log
-lint: log/jshint.log
-
-# This run the Mocha BDD test, display it to STDOUT & save it to log/mocha.log
-unit: log/mocha.log
-
-# This build the doc and README.md
-doc: README.md
-
-# This publish to NPM and push to Github, if we are on master branch only
-publish: log/npm-publish.log log/github-push.log
-
-# Clean temporary things, or things that can be automatically regenerated
-clean: clean-all
-
-
-
-# Variables
-
-MOCHA=mocha -c
-JSHINT=jshint --verbose
-
-
-
-# Files rules
-
-# JsHint STDOUT test
-log/jshint.log: log/npm-dev-install.log lib/*.js test/*.js
-	${JSHINT} lib/*.js test/*.js | tee log/jshint.log ; exit $${PIPESTATUS[0]}
-
-# Mocha BDD STDOUT test
-log/mocha.log: log/npm-dev-install.log lib/*.js test/*.js
-	${MOCHA} test/*.js -R spec | tee log/mocha.log ; exit $${PIPESTATUS[0]}
-
-# README
-README.md: documentation.md
-	cat documentation.md > README.md
-
-# Mocha Markdown BDD spec
-bdd-spec.md: log/npm-dev-install.log lib/*.js test/*.js
-	${MOCHA} test/*.js -R markdown > bdd-spec.md
-
-# Upgrade version in package.json
-log/upgrade-package.log: lib/*.js test/*.js documentation.md
-	npm version patch -m "Upgrade package.json version to %s" | tee log/upgrade-package.log ; exit $${PIPESTATUS[0]}
-
-# Publish to NPM
-log/npm-publish.log: check-if-master-branch log/upgrade-package.log
-	npm publish | tee log/npm-publish.log ; exit $${PIPESTATUS[0]}
-
-# Push to Github/master
-log/github-push.log: lib/*.js test/*.js package.json
-	#'npm version patch' create the git tag by itself... 
-	#git tag v`cat package.json | grep version | sed -r 's/.*"([0-9.]*)".*/\1/'`
-	git push origin master --tags | tee log/github-push.log ; exit $${PIPESTATUS[0]}
-
-# NPM install
-log/npm-install.log: package.json
-	npm install --production | tee log/npm-install.log ; exit $${PIPESTATUS[0]}
-
-# NPM install for developpement usage
-log/npm-dev-install.log: package.json
-	npm install | tee log/npm-dev-install.log ; exit $${PIPESTATUS[0]}
-
-
-
-# PHONY rules
-
-.PHONY: clean-all check-if-master-branch
-
-# Delete files, mostly log and non-versioned files
-clean-all:
-	rm -rf log/*.log README.md bdd-spec.md node_modules
-
-# This will fail if we are not on master branch (grep exit 1 if nothing found)
-check-if-master-branch:
-	git branch | grep  "^* master$$"
-
-

package/documentation.md

@@ -1,8 +0,0 @@
-
-
-# Array Kit
-
-An array manipulation toolbox.
-
-Early alpha.
-