fix(editor): re-org validate workflow by using config

Author: mydearxym

lib/helper/converter/editor_to_html/validator.ex renamed to lib/helper/converter/editor_to_html/validator/index.ex

@@ -3,7 +3,10 @@ defmodule Helper.Converter.EditorToHTML.Validator do
 
   alias Helper.{Utils, ValidateBySchema}
 
-  @valid_header_level [1, 2, 3]
+  alias Helper.Converter.EditorToHTML.Validator.Schema
+
+  # blocks with no children items
+  @simple_blocks ["header", "paragraph"]
 
   @valid_list_mode ["checklist", "order_list", "unorder_list"]
   @valid_list_label_type ["success", "done", "todo"]
@@ -45,33 +48,9 @@ defmodule Helper.Converter.EditorToHTML.Validator do
     {:ok, :pass}
   end
 
-  defp validate_block(%{"type" => "paragraph", "data" => %{"text" => text} = data}) do
-    schema = %{"text" => [:string]}
-
-    case ValidateBySchema.cast(schema, data) do
-      {:error, errors} ->
-        format_parse_error("paragraph", errors)
-
-      _ ->
-        {:ok, :pass}
-    end
-  end
-
-  defp validate_block(%{"type" => "header", "data" => %{"text" => text, "level" => level} = data}) do
-    schema = %{
-      "text" => [:string],
-      "level" => [enum: @valid_header_level],
-      "eyebrowTitle" => [:string, required: false],
-      "footerTitle" => [:string, required: false]
-    }
-
-    case ValidateBySchema.cast(schema, data) do
-      {:error, errors} ->
-        format_parse_error("header", errors)
-
-      _ ->
-        {:ok, :pass}
-    end
+  # validate block which have no nested items
+  defp validate_block(%{"type" => type, "data" => data}) when type in @simple_blocks do
+    validate_with(type, Schema.get(type), data)
   end
 
   defp validate_block(%{"type" => "list", "data" => %{"mode" => mode, "items" => items} = data})
@@ -117,6 +96,17 @@ defmodule Helper.Converter.EditorToHTML.Validator do
   defp validate_block(%{"type" => type}), do: raise("undown #{type} block")
   defp validate_block(_), do: raise("undown block")
 
+  # validate with given schema
+  defp validate_with(block, schema, data) do
+    case ValidateBySchema.cast(schema, data) do
+      {:error, errors} ->
+        format_parse_error(block, errors)
+
+      _ ->
+        {:ok, :pass}
+    end
+  end
+
   #  check if the given map has the right key-value fmt of the editorjs structure
   defp is_valid_editorjs_fmt(map) when is_map(map) do
     Map.has_key?(map, "time") and

lib/helper/converter/editor_to_html/validator/schema.ex

@@ -0,0 +1,22 @@
+defmodule Helper.Converter.EditorToHTML.Validator.Schema do
+  @moduledoc false
+
+  @valid_header_level [1, 2, 3]
+
+  def get("header") do
+    %{
+      "text" => [:string],
+      "level" => [enum: @valid_header_level],
+      "eyebrowTitle" => [:string, required: false],
+      "footerTitle" => [:string, required: false]
+    }
+  end
+
+  def get("paragraph") do
+    %{"text" => [:string]}
+  end
+
+  def get(_) do
+    %{}
+  end
+end

test/helper/converter/editor_to_html_test/list_test.exs

@@ -73,7 +73,7 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       ],
       "version" => "2.15.0"
     }
-    @tag :wip2
+    @tag :wip
     test "valid list parse should work" do
       {:ok, editor_string} = Jason.encode(@editor_json)
       assert {:ok, _} = Parser.to_html(editor_string)
@@ -101,7 +101,7 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       ],
       "version" => "2.15.0"
     }
-    @tag :wip2
+    @tag :wip
     test "invalid indent field should get error" do
       {:ok, editor_string} = Jason.encode(@editor_json)
       {:error, error} = Parser.to_html(editor_string)