chore: merge Fix/742 migrate doctest to jest (#749)

* Remove QuickSelect doctest

There are more Jest test cases already.

* Remove AverageMedian doctest

Already migrated to jest

* Migrate doctest for BinaryExponentiationRecursive.js

(also remove inline "main" test method)

* Migrate doctest for EulersTotient.js

(also remove inline "main" test method)

* Migrate doctest for PrimeFactors.js

(also remove inline "main" test method)

* Migrate doctest for BogoSort.js

Re-write prototype-polluting helper methods, too.

(also remove inline test driver code)

* Migrate doctest for BeadSort.js

(also remove inline test driver code)

* Migrate doctest for BucketSort.js

(also remove inline test driver code)

* Migrate doctest for CocktailShakerSort.js

(also remove inline test driver code)

* Migrate doctest for MergeSort.js

(also remove inline test driver code)

* Migrate doctest for QuickSort.js

(also remove inline test driver code)

* Migrate doctest for ReverseString.js

(also remove inline test driver code)

* Migrate doctest for ReverseString.js

* Migrate doctest for ValidateEmail.js

* Migrate doctest for ConwaysGameOfLife.js

(remove the animate code, too)

* Remove TernarySearch doctest

Already migrated to jest

* Migrate doctest for BubbleSort.js

(also remove inline test driver code)

* Remove doctest from CI and from dependencies

relates to #742
fixes #586

* Migrate doctest for RgbHsvConversion.js

* Add --fix option to "standard" npm script

* Migrate doctest for BreadthFirstSearch.js

(also remove inline test driver code)

* Migrate doctest for BreadthFirstShortestPath.js

(also remove inline test driver code)

* Migrate doctest for EulerMethod.js

(also remove inline test driver code)

Move manual test-code for plotting stuff in the browser in a distinct file, too. Those "*.manual-test.js" files are excluded from the UpdateDirectory.mjs script, as well.

* Migrate doctest for Mandelbrot.js

(also remove inline test driver code & moved manual drawing test into a *.manual-test.js)

* Migrate doctest for FloodFill.js

* Migrate doctest for KochSnowflake.js

(also move manual drawing test into a *.manual-test.js)

* Update npm lockfile

* Update README and COMMITTING with a few bits & bobs regarding testing & code quality
This commit is contained in:
Roland Hummel
2021-10-07 09:03:38 +02:00
committed by GitHub
parent 6eeb989930
commit b13b12e88c
53 changed files with 882 additions and 13514 deletions

View File

@ -1,44 +1,25 @@
/**
* Flood fill, also called seed fill, is an algorithm that determines and alters the area connected
* to a given node in a multi-dimensional array with some matching attribute. It is used in the
* "bucket" fill tool of paint programs to fill connected, similarly-colored areas with a different
* color. (description adapted from https://en.wikipedia.org/wiki/Flood_fill) (see also:
* https://www.techiedelight.com/flood-fill-algorithm/).
* Flood fill.
*
* Flood fill, also called seed fill, is an algorithm that determines and alters the area connected to a given node in a
* multi-dimensional array with some matching attribute. It is used in the "bucket" fill tool of paint programs to fill
* connected, similarly-colored areas with a different color.
*
* (description adapted from https://en.wikipedia.org/wiki/Flood_fill)
* @see https://www.techiedelight.com/flood-fill-algorithm/
*/
const neighbors = [[-1, -1], [-1, 0], [-1, 1], [0, -1], [0, 1], [1, -1], [1, 0], [1, 1]]
const black = [0, 0, 0]
const green = [0, 255, 0]
const violet = [255, 0, 255]
const white = [255, 255, 255]
const orange = [255, 128, 0] // eslint-disable-line
/*
Doctests
> testBreadthFirst([1, 1], green, orange, [1, 1]);
orange
> testBreadthFirst([1, 1], green, orange, [0, 1]);
violet
> testBreadthFirst([1, 1], green, orange, [6, 4]);
white
> testDepthFirst([1, 1], green, orange, [1, 1]);
orange
> testDepthFirst([1, 1], green, orange, [0, 1]);
violet
> testDepthFirst([1, 1], green, orange, [6, 4]);
white
*/
/**
* Implements the flood fill algorithm through a breadth-first approach using a queue.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
function breadthFirstSearch (rgbData, location, targetColor, replacementColor) {
* Implements the flood fill algorithm through a breadth-first approach using a queue.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
export function breadthFirstSearch (rgbData, location, targetColor, replacementColor) {
if (location[0] < 0 ||
location[0] >= rgbData.length ||
location[1] < 0 ||
@ -55,14 +36,14 @@ function breadthFirstSearch (rgbData, location, targetColor, replacementColor) {
}
/**
* Implements the flood fill algorithm through a depth-first approach using recursion.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
function depthFirstSearch (rgbData, location, targetColor, replacementColor) {
* Implements the flood fill algorithm through a depth-first approach using recursion.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
export function depthFirstSearch (rgbData, location, targetColor, replacementColor) {
if (location[0] < 0 ||
location[0] >= rgbData.length ||
location[1] < 0 ||
@ -74,14 +55,14 @@ function depthFirstSearch (rgbData, location, targetColor, replacementColor) {
}
/**
* Utility-function to implement the breadth-first loop
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
* @param queue The locations that still need to be visited.
*/
* Utility-function to implement the breadth-first loop.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
* @param queue The locations that still need to be visited.
*/
function breadthFirstFill (rgbData, location, targetColor, replacementColor, queue) {
const currentLocation = queue[0]
queue.shift()
@ -100,13 +81,13 @@ function breadthFirstFill (rgbData, location, targetColor, replacementColor, que
}
/**
* Utility-function to implement the depth-first loop
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
* Utility-function to implement the depth-first loop.
*
* @param rgbData The image to which the algorithm is applied.
* @param location The start location on the image.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
*/
function depthFirstFill (rgbData, location, targetColor, replacementColor) {
if (rgbData[location[0]][location[1]] === targetColor) {
rgbData[location[0]][location[1]] = replacementColor
@ -120,61 +101,3 @@ function depthFirstFill (rgbData, location, targetColor, replacementColor) {
}
}
}
/**
* Generates the rgbData-matrix for the tests
*
* @return example rgbData-matrix
*/
function generateTestRgbData () {
const layout = [
[violet, violet, green, green, black, green, green],
[violet, green, green, black, green, green, green],
[green, green, green, black, green, green, green],
[black, black, green, black, white, white, green],
[violet, violet, black, violet, violet, white, white],
[green, green, green, violet, violet, violet, violet],
[violet, violet, violet, violet, violet, violet, violet]
]
// transpose layout-matrix so the x-index comes before the y-index
const transposed = []
for (let x = 0; x < layout[0].length; x++) {
transposed[x] = []
for (let y = 0; y < layout.length; y++) {
transposed[x][y] = layout[y][x]
}
}
return transposed
}
/**
* Utility-function to test the function "breadthFirstSearch"
*
* @param fillLocation The start location on the image where the flood fill is applied.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
* @param testLocation The location of the color to be checked.
* @return The color at testLocation
*/
function testBreadthFirst (fillLocation, targetColor, replacementColor, testLocation) {// eslint-disable-line
const rgbData = generateTestRgbData()
breadthFirstSearch(rgbData, fillLocation, targetColor, replacementColor)
return rgbData[testLocation[0]][testLocation[1]]
}
/**
* Utility-function to test the function "depthFirstSearch"
*
* @param fillLocation The start location on the image where the flood fill is applied.
* @param targetColor The old color to be replaced.
* @param replacementColor The new color to replace the old one.
* @param testLocation The location of the color to be checked.
* @return The color at testLocation
*/
function testDepthFirst (fillLocation, targetColor, replacementColor, testLocation) {// eslint-disable-line
const rgbData = generateTestRgbData()
depthFirstSearch(rgbData, fillLocation, targetColor, replacementColor)
return rgbData[testLocation[0]][testLocation[1]]
}