Merge branch 'dev'

Author: karnthis

changelog.md

@@ -28,6 +28,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial Release
 
 ## Minor Releases:
+### [v1.3.0] - 2022 01 29
+#### Added
+- `flipCoin()` Generates a random boolean value
+- `randomCaseString()` Generates a true mixed-case random string of specified length
+#### Changed
+- `random()` Fixed bug where defaulting to randomly returning 0 or 1 always returned 0
+
 ## [v1.2.2] - 2021 10 24
 #### Changed
 - Changelog tweaks
@@ -74,7 +81,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- LINKS -->
 <!-- RELEASES -->
-[Unreleased]: https://github.com/karnthis/make-random/compare/v1.2.2...dev
+[Unreleased]: https://github.com/karnthis/make-random/compare/v1.3.0...dev
+[v1.3.0]: https://github.com/karnthis/make-random/compare/v1.2.2...v1.3.0
 [v1.2.2]: https://github.com/karnthis/make-random/compare/v1.2.0...v1.2.2
 [v1.2.0]: https://github.com/karnthis/make-random/compare/v1.1.0...v1.2.0
 [v1.1.0]: https://github.com/karnthis/make-random/compare/v1.0.0...v1.1.0

libs/index.js

@@ -11,19 +11,26 @@ const { asUpper, asLower } = require('../data/letters.js')
 function foundation(base) {
 	const byteCount = makeByteCount(base)
 	return promiseCryptoRBytes(byteCount)
-	.then(buf => buf.toString('hex'))
+		.then(buf => buf.toString('hex'))
 }
 
 function numberFoundation(base) {
 	const trueBase = Math.abs(base)
 	return foundation(trueBase)
-	.then(hex => parseInt(hex, 16) % trueBase)
+		.then(hex => {
+			const val = parseInt(hex, 16)
+			if (trueBase === 1) {
+				return val % 2
+			} else {
+				return val % trueBase
+			}
+		})
 }
 
 function stringFoundation(base) {
 	const trueBase = Math.abs(base)
 	return promiseCryptoRBytes(trueBase)
-	.then(buf => buf.toString('hex'))
+		.then(buf => buf.toString('hex'))
 }
 
 function promiseCryptoRBytes(byteCount = 1) {
@@ -59,7 +66,11 @@ async function randomLetter(count = 3, source) {
 function random(v = 1) {
 	const pureV = cleanInteger(v, 1)
 	return numberFoundation(pureV)
-	.then(res => (pureV < 0 && res !== 0) ? res * -1 : res)
+		.then(res => (pureV < 0 && res !== 0) ? res * -1 : res)
+}
+function coinFlip() {
+	return random()
+		.then(num => num === 0)
 }
 function randomInRange(v1 = -100, v2 = 100) {
 	v1 = cleanInteger(v1, 1)
@@ -76,7 +87,7 @@ function randomInRange(v1 = -100, v2 = 100) {
 	}
 	const baseValue = high - low
 	return numberFoundation(baseValue)
-	.then(res => (baseValue < 0) ? (res * -1) + low : res + low)
+		.then(res => (baseValue < 0) ? (res * -1) + low : res + low)
 }
 
 function randomAZString(len = 10, upper = true) {
@@ -88,7 +99,18 @@ function randomAZString(len = 10, upper = true) {
 }
 function randomString(len = 10) {
 	return stringFoundation(len)
-	.then(hex => hex.slice(0, len))
+		.then(hex => hex.slice(0, len))
+}
+function randomCaseString(len = 10) {
+	return stringFoundation(len)
+		.then(hex => hex.slice(0, len))
+		.then(async (str) => {
+			return Promise.all(str
+				.split('')
+				.map(async (char) => (await coinFlip()) ? char : char.toUpperCase())
+			)
+		})
+		.then(strArr => strArr.join(''))
 }
 
 async function randomLatin(len = 5) {
@@ -102,29 +124,29 @@ async function randomLatin(len = 5) {
 
 async function randomUUID() {
 	return stringFoundation(16)
-	.then(res => {
-		const byteTo4 = res.slice(12,14)
-		const maskOr = parseInt('01000000', 2)
-		const maskAnd = parseInt('01001111', 2)
-		const byteSet4 = (maskOr | (maskAnd & parseInt(byteTo4, 16)))
-		return res.slice(0,12) + byteSet4.toString(16) + res.slice(14)
-	})
-	.then(res => {
-		const bytePart2 = res.slice(16,18)
-		const maskOr = parseInt('10000000', 2)
-		const maskAnd = parseInt('10111111', 2)
-		const byteSetPart2 = (maskOr | (maskAnd & parseInt(bytePart2, 16)))
-		return res.slice(0,16) + byteSetPart2.toString(16) + res.slice(18)
-	})
-	.then(res => {
-		return [
-			res.slice(0,8),
-			res.slice(8, 12),
-			res.slice(12,16),
-			res.slice(16,20),
-			res.slice(20),
-		].join("-").toUpperCase()
-	})
+		.then(res => {
+			const byteTo4 = res.slice(12,14)
+			const maskOr = parseInt('01000000', 2)
+			const maskAnd = parseInt('01001111', 2)
+			const byteSet4 = (maskOr | (maskAnd & parseInt(byteTo4, 16)))
+			return res.slice(0,12) + byteSet4.toString(16) + res.slice(14)
+		})
+		.then(res => {
+			const bytePart2 = res.slice(16,18)
+			const maskOr = parseInt('10000000', 2)
+			const maskAnd = parseInt('10111111', 2)
+			const byteSetPart2 = (maskOr | (maskAnd & parseInt(bytePart2, 16)))
+			return res.slice(0,16) + byteSetPart2.toString(16) + res.slice(18)
+		})
+		.then(res => {
+			return [
+				res.slice(0,8),
+				res.slice(8, 12),
+				res.slice(12,16),
+				res.slice(16,20),
+				res.slice(20),
+			].join("-").toUpperCase()
+		})
 }
 
 // WRAPPERS
@@ -146,6 +168,7 @@ function randomWords(len) {
 
 module.exports = {
 	// WRAPPERS
+	coinFlip,
 	flexRange,
 	setRange,
 	azString,
@@ -155,6 +178,7 @@ module.exports = {
 	randomInRange,
 	randomString,
 	randomAZString,
+	randomCaseString,
 	randomLatin,
 	randomUUID
 }

readme.md

@@ -19,9 +19,11 @@ npm install make-random
 ## Examples
 ### Jump-to:
 - [random()](#random)
+- [coinFlip()](#coinFlip)
 - [randomInRange()](#randomInRange)
 - [randomAZString()](#randomAZString)
 - [randomString()](#randomString)
+- [randomCaseString()](#randomCaseString)
 - [randomLatin()](#randomLatin)
 - [randomUUID()](#randomUUID)
 
@@ -54,6 +56,18 @@ random()
 .then(resp => console.log(resp))
 ```
 
+### coinFlip()
+
+The `coinFlip()` method accepts no arguments. The method returns a random boolean value.
+
+```javascript
+const { coinFlip } = require('make-random')
+
+// Return a random boolean value
+coinFlip()
+.then(resp => console.log(resp))
+```
+
 ### randomInRange()
 
 The `randomInRange()` method accepts any integers or integer-like strings as optional single or pair arguments. The method returns a true integer between the 2 arguments given. If only 1 argument is given, the random number will be between the argument value and 100. If no arguments are given, the method defaults to returning a random integer between -100 and 100. If the arguements are the same value (-10, "-10"), the method will return an integer between 0 and the passed arguments as if `random()` was used.
@@ -140,6 +154,26 @@ randomString('20')
 .then(resp => console.log(resp))
 ```
 
+### randomCaseString()
+
+The `randomCaseString()` method accepts an optional integer or integer-like argument. It returns an alpha-numeric randomly mixed-case string of the specified length. If no argument is given, method defaults to a 10 character string.
+
+```javascript
+const { randomCaseString } = require('make-random')
+
+// Return 10 character mixed-case random string
+randomCaseString()
+.then(resp => console.log(resp))
+
+// Return 15 character mixed-case random string
+randomCaseString(15)
+.then(resp => console.log(resp))
+
+// Accept integer or integer-like string
+randomCaseString('20')
+.then(resp => console.log(resp))
+```
+
 ### randomLatin()
 
 The `randomLatin()` method accepts an optional integer or integer-like argument. It returns a string with the specified number of random latin words. If no argument is given, method defaults to 5 words. All words start with E or R.