From d4720c712d99b51d3d6062b1f5bc281a82d70b79 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Ribeiro?= <me@joseribeiro.dev>
Date: Sun, 28 Apr 2024 08:21:18 -0300
Subject: [PATCH] test(FormBuilder): check whether disabled is being respected

---
 .../FormBuilder/fields/CheckboxField.tsx      |  2 +
 .../FormBuilder/fields/TextAreaField.tsx      |  2 +
 .../fields/selects/SelectField.tsx            | 80 +++++++++----------
 src/components/FormBuilder/isFieldDisabled.ts | 12 +++
 .../FormBuilder/CheckboxField.test.tsx        | 12 +++
 .../FormBuilder/DatePickerInput.test.tsx      |  7 ++
 .../components/FormBuilder/FormField.test.tsx | 14 ++++
 .../FormBuilder/HiddenField.test.tsx          | 11 +++
 .../FormBuilder/InputField.test.tsx           | 28 ++++---
 .../FormBuilder/SwitchField.test.tsx          |  6 ++
 .../FormBuilder/TextAreaField.test.tsx        |  5 ++
 tests/helpers/renderFormField.tsx             | 11 +--
 tsconfig.json                                 |  1 -
 13 files changed, 133 insertions(+), 58 deletions(-)
 create mode 100644 src/components/FormBuilder/isFieldDisabled.ts

diff --git a/src/components/FormBuilder/fields/CheckboxField.tsx b/src/components/FormBuilder/fields/CheckboxField.tsx
index f7eb022..d1ad1d0 100644
--- a/src/components/FormBuilder/fields/CheckboxField.tsx
+++ b/src/components/FormBuilder/fields/CheckboxField.tsx
@@ -9,6 +9,7 @@ import {
 } from "#/components/ui/Form";
 
 import { BaseField, withConditional } from "../fields";
+import isFieldDisabled from "../isFieldDisabled";
 
 export interface CheckboxFieldProps extends BaseField {
   type: "checkbox";
@@ -31,6 +32,7 @@ export const CheckboxField = withConditional<CheckboxFieldProps>(
             <Checkbox
               checked={formField.value}
               onCheckedChange={formField.onChange}
+              disabled={isFieldDisabled(form, field)}
             />
           </FormControl>
           <div className="space-y-1 leading-none">
diff --git a/src/components/FormBuilder/fields/TextAreaField.tsx b/src/components/FormBuilder/fields/TextAreaField.tsx
index 3ed0b6b..532ee02 100644
--- a/src/components/FormBuilder/fields/TextAreaField.tsx
+++ b/src/components/FormBuilder/fields/TextAreaField.tsx
@@ -11,6 +11,7 @@ import {
 import { Textarea } from "#/components/ui/Textarea";
 
 import { BaseField, withConditional } from "../fields";
+import isFieldDisabled from "../isFieldDisabled";
 
 export interface TextAreaFieldProps extends BaseField {
   length?: {
@@ -47,6 +48,7 @@ export const TextAreaField = withConditional<TextAreaFieldProps>(
             <FormDescription>{field.description}</FormDescription>
             <FormControl>
               <Textarea
+                disabled={isFieldDisabled(form, field)}
                 placeholder={field.placeholder}
                 className="resize-none"
                 {...formField}
diff --git a/src/components/FormBuilder/fields/selects/SelectField.tsx b/src/components/FormBuilder/fields/selects/SelectField.tsx
index fae49c1..f143d2c 100644
--- a/src/components/FormBuilder/fields/selects/SelectField.tsx
+++ b/src/components/FormBuilder/fields/selects/SelectField.tsx
@@ -10,6 +10,7 @@ import {
 import * as Select from "#/components/ui/Select";
 
 import { BaseField, withConditional } from "../../fields";
+import isFieldDisabled from "../../isFieldDisabled";
 
 export interface SelectFieldProps extends BaseField {
   options?: Array<{
@@ -20,48 +21,41 @@ export interface SelectFieldProps extends BaseField {
 }
 
 export const SelectField = withConditional<SelectFieldProps>(
-  ({ form, field }) => {
-    const disabled =
-      typeof field.disabled === "function"
-        ? field.disabled(form.getValues())
-        : field.disabled;
+  ({ form, field }) => (
+    <FormField
+      control={form.control}
+      name={field.name}
+      rules={field.required ? { required: true } : undefined}
+      render={({ field: formField }) => (
+        <FormItem className="w-full">
+          <FormLabel tooltip={field.tooltip}>{field.label}</FormLabel>
+          <FormDescription>{field.description}</FormDescription>
+          <Select.SelectRoot
+            onValueChange={formField.onChange}
+            defaultValue={String(formField.value)}
+            name={field.name}
+            disabled={isFieldDisabled(form, field)}
+          >
+            <FormControl>
+              <Select.SelectTrigger className="h-10 w-full rounded-md border dark:border-2 shadow-none">
+                <Select.SelectValue placeholder={field.placeholder} />
+              </Select.SelectTrigger>
+            </FormControl>
+            <Select.SelectContent className="z-[10000]">
+              {field.options?.map((option) => (
+                <Select.SelectItem
+                  key={String(option.value)}
+                  value={String(option.value)}
+                >
+                  {option.label}
+                </Select.SelectItem>
+              ))}
+            </Select.SelectContent>
+          </Select.SelectRoot>
 
-    return (
-      <FormField
-        control={form.control}
-        name={field.name}
-        rules={field.required ? { required: true } : undefined}
-        render={({ field: formField }) => (
-          <FormItem className="w-full">
-            <FormLabel tooltip={field.tooltip}>{field.label}</FormLabel>
-            <FormDescription>{field.description}</FormDescription>
-            <Select.SelectRoot
-              onValueChange={formField.onChange}
-              defaultValue={String(formField.value)}
-              name={field.name}
-              disabled={disabled}
-            >
-              <FormControl>
-                <Select.SelectTrigger className="h-10 w-full rounded-md border dark:border-2 shadow-none">
-                  <Select.SelectValue placeholder={field.placeholder} />
-                </Select.SelectTrigger>
-              </FormControl>
-              <Select.SelectContent className="z-[10000]">
-                {field.options?.map((option) => (
-                  <Select.SelectItem
-                    key={String(option.value)}
-                    value={String(option.value)}
-                  >
-                    {option.label}
-                  </Select.SelectItem>
-                ))}
-              </Select.SelectContent>
-            </Select.SelectRoot>
-
-            <FormMessage />
-          </FormItem>
-        )}
-      />
-    );
-  }
+          <FormMessage />
+        </FormItem>
+      )}
+    />
+  )
 );
diff --git a/src/components/FormBuilder/isFieldDisabled.ts b/src/components/FormBuilder/isFieldDisabled.ts
new file mode 100644
index 0000000..a09d762
--- /dev/null
+++ b/src/components/FormBuilder/isFieldDisabled.ts
@@ -0,0 +1,12 @@
+import { CommonFieldProps, FormFieldProps } from "./fields";
+
+type FieldProps = CommonFieldProps<FormFieldProps>;
+
+export default function isFieldDisabled(
+  form: FieldProps["form"],
+  field: FieldProps["field"]
+) {
+  return typeof field.disabled === "function"
+    ? field.disabled(form.getValues())
+    : field.disabled;
+}
diff --git a/tests/components/FormBuilder/CheckboxField.test.tsx b/tests/components/FormBuilder/CheckboxField.test.tsx
index c765b89..66cf8c0 100644
--- a/tests/components/FormBuilder/CheckboxField.test.tsx
+++ b/tests/components/FormBuilder/CheckboxField.test.tsx
@@ -18,6 +18,18 @@ describe("CheckboxField", () => {
     expect(checkboxElement).toBeInTheDocument();
   });
 
+  it("renders the checkbox label correctly", () => {
+    renderFormField(CheckboxField, field);
+    const labelElement = screen.getByText("Test Checkbox");
+    expect(labelElement).toBeInTheDocument();
+  });
+
+  it("disables the checkbox when the disabled prop is set to true", () => {
+    renderFormField(CheckboxField, { ...field, disabled: true });
+    const checkboxElement = screen.getByRole("checkbox");
+    expect(checkboxElement).toBeDisabled();
+  });
+
   it("updates the form state correctly when interacted with", () => {
     const { form } = renderFormField(CheckboxField, field);
 
diff --git a/tests/components/FormBuilder/DatePickerInput.test.tsx b/tests/components/FormBuilder/DatePickerInput.test.tsx
index a8d0583..d54e7e4 100644
--- a/tests/components/FormBuilder/DatePickerInput.test.tsx
+++ b/tests/components/FormBuilder/DatePickerInput.test.tsx
@@ -18,6 +18,13 @@ describe("DatePickerInput", () => {
     expect(datePickerElement).toBeInTheDocument();
   });
 
+  it("displays the selected date in the correct format", () => {
+    vi.setSystemTime(mockDate);
+    renderFormField(DatePickerInput, { ...field, defaultValue: mockDate });
+    const buttonElement = screen.getByRole("button");
+    expect(buttonElement).toHaveTextContent("Jan 1, 2022");
+  });
+
   it("updates the form state correctly when a date is selected", () => {
     vi.setSystemTime(mockDate);
     const { form } = renderFormField(DatePickerInput, field);
diff --git a/tests/components/FormBuilder/FormField.test.tsx b/tests/components/FormBuilder/FormField.test.tsx
index dc16ecd..47b0e24 100644
--- a/tests/components/FormBuilder/FormField.test.tsx
+++ b/tests/components/FormBuilder/FormField.test.tsx
@@ -15,6 +15,20 @@ describe("FormField", () => {
     );
   };
 
+  // it("renders the correct error message when validation fails", async () => {
+  //   render(
+  //     renderFormField({
+  //       name: "test",
+  //       rules: { required: "Field is required" },
+  //       render: ({ field }) => <input {...field} />,
+  //     })
+  //   );
+  //   const inputElement = screen.getByRole("textbox");
+  //   fireEvent.blur(inputElement);
+  //   const errorMessage = await screen.findByRole("alert");
+  //   expect(errorMessage).toHaveTextContent("Field is required");
+  // });
+
   it("renders the appropriate field component based on the render prop", () => {
     render(
       renderFormField({
diff --git a/tests/components/FormBuilder/HiddenField.test.tsx b/tests/components/FormBuilder/HiddenField.test.tsx
index 6fc0237..6f8884a 100644
--- a/tests/components/FormBuilder/HiddenField.test.tsx
+++ b/tests/components/FormBuilder/HiddenField.test.tsx
@@ -1,4 +1,5 @@
 import { describe, it, expect } from "vitest";
+import { screen } from "@testing-library/react";
 import { HiddenField } from "#/components";
 import { renderFormField } from "../../../tests/helpers/renderFormField";
 
@@ -12,4 +13,14 @@ describe("HiddenField", () => {
     const hiddenInput = form.getValues("test");
     expect(hiddenInput).toBe("hiddenValue");
   });
+
+  it("does not render any visible elements", () => {
+    renderFormField(HiddenField, {
+      type: "hidden",
+      name: "test",
+      value: "hiddenValue",
+    });
+    const hiddenInput = screen.queryByRole("textbox");
+    expect(hiddenInput).not.toBeInTheDocument();
+  });
 });
diff --git a/tests/components/FormBuilder/InputField.test.tsx b/tests/components/FormBuilder/InputField.test.tsx
index 50c8f75..05a5a9e 100644
--- a/tests/components/FormBuilder/InputField.test.tsx
+++ b/tests/components/FormBuilder/InputField.test.tsx
@@ -4,30 +4,40 @@ import { renderFormField } from "tests/helpers/renderFormField";
 import { InputField } from "#/components";
 
 describe("InputField", () => {
+  const field = { type: "input", name: "test", value: "" };
   it("renders an input element", () => {
-    const field = { type: "input", name: "test", value: "" };
     renderFormField(InputField, field);
     const inputElement = screen.getByRole("textbox");
     expect(inputElement).toBeInTheDocument();
   });
 
-  // it("applies the appropriate validation rules", () => {
-  //   const field = { type: "input", name: "test", required: true };
-  //   render(<TestForm field={field} />);
+  it("applies the disabled prop when set to true", () => {
+    renderFormField(InputField, { ...field, disabled: true });
+    const inputElement = screen.getByRole("textbox");
+    expect(inputElement).toBeDisabled();
+  });
+
+  // it("shows an error message when the input value is invalid", async () => {
+  //   renderFormField(InputField, {
+  //     ...field,
+  //     required: true,
+  //     length: { minimum: 5 },
+  //   });
   //   const inputElement = screen.getByRole("textbox");
-  //   fireEvent.change(inputElement, { target: { value: "" } });
-  //   expect(inputElement).toBeInvalid();
+  //   fireEvent.change(inputElement, { target: { value: "test" } });
+  //   fireEvent.blur(inputElement);
+  //   const errorMessage = await screen.findByRole("alert");
+  //   expect(errorMessage).toBeInTheDocument();
   // });
 
   it("updates the form state correctly when interacted with", () => {
-    const field = {
+    const { form } = renderFormField(InputField, {
       type: "input",
       name: "test",
       value: "",
       defaultValue: "",
       mode: "text",
-    } as const;
-    const { form } = renderFormField(InputField, field);
+    });
     const inputElement = screen.getByRole("textbox");
     fireEvent.change(inputElement, { target: { value: "Test value" } });
     expect(form.getValues("test")).toBe("Test value");
diff --git a/tests/components/FormBuilder/SwitchField.test.tsx b/tests/components/FormBuilder/SwitchField.test.tsx
index 509653a..6558944 100644
--- a/tests/components/FormBuilder/SwitchField.test.tsx
+++ b/tests/components/FormBuilder/SwitchField.test.tsx
@@ -19,4 +19,10 @@ describe("SwitchField", () => {
     fireEvent.click(switchElement);
     expect(form.getValues("test")).toBe(true);
   });
+
+  it("disables the switch when the disabled prop is set to true", () => {
+    renderFormField(SwitchField, { ...field, disabled: true });
+    const switchElement = screen.getByRole("switch");
+    expect(switchElement).toBeDisabled();
+  });
 });
diff --git a/tests/components/FormBuilder/TextAreaField.test.tsx b/tests/components/FormBuilder/TextAreaField.test.tsx
index e9d83ef..5cd3293 100644
--- a/tests/components/FormBuilder/TextAreaField.test.tsx
+++ b/tests/components/FormBuilder/TextAreaField.test.tsx
@@ -20,6 +20,11 @@ describe("TextAreaField", () => {
   //   fireEvent.change(textareaElement, { target: { value: "" } });
   //   expect(textareaElement).toBeInvalid();
   // });
+  it("applies the disabled prop when set to true", () => {
+    renderFormField(TextAreaField, { ...field, disabled: true });
+    const textareaElement = screen.getByRole("textbox");
+    expect(textareaElement).toBeDisabled();
+  });
 
   it("updates the form state correctly when interacted with", () => {
     const { form } = renderFormField(TextAreaField, field);
diff --git a/tests/helpers/renderFormField.tsx b/tests/helpers/renderFormField.tsx
index 08488f6..91fa1f4 100644
--- a/tests/helpers/renderFormField.tsx
+++ b/tests/helpers/renderFormField.tsx
@@ -1,11 +1,12 @@
-import React from "react";
+import * as React from "react";
 import { render, renderHook } from "@testing-library/react";
-import { useForm, FormProvider } from "react-hook-form";
+import { useForm, FormProvider, UseFormProps } from "react-hook-form";
+import { CommonFieldProps, FormFieldProps } from "#/components";
 
 export const renderFormField = (
-  FieldComponent: React.ComponentType<any>,
-  field: any,
-  formProps: any = {}
+  FieldComponent: React.ComponentType<CommonFieldProps<FormFieldProps>>,
+  field: FormFieldProps,
+  formProps: UseFormProps
 ) => {
   const { result } = renderHook(() => useForm(formProps));
   const form = result.current;
diff --git a/tsconfig.json b/tsconfig.json
index 223b67f..ecc0dee 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -16,7 +16,6 @@
     "strict": true,
     "lib": ["dom", "dom.iterable", "esnext"],
     "types": ["vitest/globals"],
-
     "plugins": [
       { "transform": "typescript-transform-paths" },
       { "transform": "typescript-transform-paths", "afterDeclarations": true }