From 510b567a7cc2faecfaec3c21015cd9a97ee2378e Mon Sep 17 00:00:00 2001
From: Tandashi <18377875+Tandashi@users.noreply.github.com>
Date: Wed, 19 Oct 2022 19:41:40 +0200
Subject: [PATCH] feat(https://github.com/emsifa/validasaur/issues/33): Add
 `notNaN` rule

Added a `nonNaN` rule since the existing rules like `isNumber`, `isFloat`, `isNumeric`, `minNumber`, `maxNumber` all pass when providing a `NaN` value. To provide backwards compatibility the existing rules have not been changed.
---
 README.md                   | 24 ++++++++++++++++++++++++
 src/messages.ts             |  1 +
 src/rules.ts                |  1 +
 src/rules/not_nan.ts        |  6 ++++++
 tests/rules/not_nan.test.ts | 11 +++++++++++
 5 files changed, 43 insertions(+)
 create mode 100644 src/rules/not_nan.ts
 create mode 100644 tests/rules/not_nan.test.ts

diff --git a/README.md b/README.md
index 717cb25..fc16c5d 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,7 @@ Validasaur is Deno validation library slightly inspired by Laravel Validation.
     - [`minNumber(minValue: number)`](#minnumberminvalue-number)
     - [`notIn(disallowedValues: PrimitiveTypes[])`](#notindisallowedvalues-primitivetypes)
     - [`notNull`](#notnull)
+    - [`notNaN`](#notnan)
     - [`nullable`](#nullable)
     - [`numberBetween(minValue: number, maxValue: number)`](#numberbetweenminvalue-number-maxvalue-number)
     - [`requiredIf(field: string, fieldValue: any)`](#requirediffield-string-fieldvalue-any)
@@ -462,6 +463,9 @@ Value under this field must be valid email address.
 
 #### `isFloat`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Value under this field must be a float number.
 
 * Invalid values: `"0.1"`, `[]`, `0`, `1`, `123`, etc.
@@ -487,6 +491,9 @@ const [ passes, errors ] = await validate({
 
 #### `isInt`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Value under this field must be an integer.
 
 * Invalid values: `0.5`, `"123"`, etc.
@@ -508,6 +515,9 @@ Value under this field must be valid IPv6.
 
 #### `isNumber`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Value under this field must be a float or an integer.
 
 * Invalid values: `"1"`, `"1.5"`, etc.
@@ -515,6 +525,9 @@ Value under this field must be a float or an integer.
 
 #### `isNumeric`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Same as `asNumber`, but it allows numeric string.
 
 * Invalid values: `"1.0abc"`, `"x.1"`, etc.
@@ -587,6 +600,9 @@ const [ passes, errors ] = await validate({
 
 #### `maxNumber(maxValue: number)`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Value under this field should be a number that is not higher than `maxValue`.
 
 Example:
@@ -623,6 +639,9 @@ const [ passes, errors ] = await validate({
 
 #### `minNumber(minValue: number)`
 
+> **Warning**
+> This does not check for `NaN`. Please use `notNaN` as well.
+
 Value under this field should be a number that is not lower than `minValue`.
 
 Example:
@@ -663,6 +682,11 @@ const [ passes, errors ] = await validate({
 
 Value under this field must not be `null`.
 
+#### `notNaN`
+
+Value under this field must not be `NaN`.
+
+
 #### `nullable`
 
 In case you need a `required` field that accept `null` value,
diff --git a/src/messages.ts b/src/messages.ts
index 323cb23..6142af4 100644
--- a/src/messages.ts
+++ b/src/messages.ts
@@ -21,6 +21,7 @@ export const defaultMessages: ValidationMessages = {
   minNumber: ":attr cannot be lower than :minValue",
   notIn: ":value is not allowed",
   notNull: ":value cannot be null",
+  notNaN: ":attr cannot be NaN",
   numberBetween: ":value must be between :minValue - :maxValue",
   required: ":attr is required",
   default: ":attr is invalid",
diff --git a/src/rules.ts b/src/rules.ts
index e52796f..0038945 100644
--- a/src/rules.ts
+++ b/src/rules.ts
@@ -24,6 +24,7 @@ export * from "./rules/min_length.ts";
 export * from "./rules/min_number.ts";
 export * from "./rules/not_in.ts";
 export * from "./rules/not_null.ts";
+export * from "./rules/not_nan.ts";
 export * from "./rules/nullable.ts";
 export * from "./rules/number_between.ts";
 export * from "./rules/match.ts";
diff --git a/src/rules/not_nan.ts b/src/rules/not_nan.ts
new file mode 100644
index 0000000..b0fba88
--- /dev/null
+++ b/src/rules/not_nan.ts
@@ -0,0 +1,6 @@
+import type { Validity } from "../types.ts";
+import { invalid } from "../utils.ts";
+
+export function notNaN(value: any): Validity {
+  return isNaN(value) ? invalid("notNaN", { value }, true) : undefined;
+}
diff --git a/tests/rules/not_nan.test.ts b/tests/rules/not_nan.test.ts
new file mode 100644
index 0000000..ce34c3a
--- /dev/null
+++ b/tests/rules/not_nan.test.ts
@@ -0,0 +1,11 @@
+import { notNaN } from "../../src/rules/not_nan.ts";
+import { invalid } from "../../src/utils.ts";
+import { assertInvalid, assertValid } from "../utils.ts";
+
+Deno.test("rules.notNaN(NaN) should be invalid", () => {
+  assertInvalid(notNaN(NaN), invalid("notNaN", { value: NaN }, true));
+});
+
+Deno.test("rules.notNaN(0) should be valid", () => {
+  assertValid(notNaN(0));
+});