refactor(editor): spec-types && add more tests

Author: mydearxym

lib/helper/converter/editor_to_html/frags/table.ex

@@ -5,10 +5,11 @@ defmodule Helper.Converter.EditorToHTML.Frags.Table do
   see https://editorjs.io/
   """
   alias Helper.Converter.EditorToHTML.Class
-  # alias Helper.Types, as: T
+  alias Helper.Types, as: T
 
   @class get_in(Class.article(), ["table"])
 
+  @spec get_row([T.editor_table_cell()]) :: T.html()
   def get_row(group_items) do
     tr_content =
       Enum.reduce(group_items, "", fn item, acc ->
@@ -19,6 +20,7 @@ defmodule Helper.Converter.EditorToHTML.Frags.Table do
     ~s(<tr>#{tr_content}</tr>)
   end
 
+  @spec frag(:td, T.editor_table_cell()) :: T.html()
   def frag(:td, item) do
     %{
       "align" => align,
@@ -43,6 +45,7 @@ defmodule Helper.Converter.EditorToHTML.Frags.Table do
     end
   end
 
+  @spec frag(:th, T.editor_table_cell()) :: T.html()
   def frag(:th, item) do
     %{"align" => align, "text" => text} = item
 

lib/helper/types.ex

@@ -59,6 +59,22 @@ defmodule Helper.Types do
           required(:text) => String.t(),
           prefixIndex: String.t()
         }
+
+  @typedoc """
+  editor.js's Table align type
+  """
+  @type editor_table_align :: :center | :left | :right
+
+  @typedoc """
+  editor.js's Table td type
+  """
+  @type editor_table_cell :: %{
+          required(:text) => String.t(),
+          required(:align) => editor_table_align,
+          isStripe: Boolean.t(),
+          isHeader: Boolean.t()
+        }
+
   @typedoc """
   html fragment
   """

test/helper/converter/editor_to_html_test/table_test.exs

@@ -8,7 +8,7 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.Table do
   alias Helper.Utils
 
   @root_class Class.article()
-  @class get_in(@root_class, ["list"])
+  @class get_in(@root_class, ["table"])
 
   describe "[table block unit]" do
     defp set_items(column_count, items) do
@@ -97,25 +97,28 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.Table do
       {:ok, editor_string} = Jason.encode(editor_json)
       {:ok, converted} = Parser.to_html(editor_string)
 
-      IO.inspect(converted, label: "table >>")
+      th_header_class = @class["th_header"]
+      td_stripe_class = @class["td_stripe"]
 
-      # unorder_list_prefix_class = @class["unorder_list_prefix"]
-      # assert Utils.str_occurence(converted, unorder_list_prefix_class) == 3
+      assert Utils.str_occurence(converted, th_header_class) == 4
+      assert Utils.str_occurence(converted, td_stripe_class) == 3
     end
 
-    # @tag :wip
-    # test "invalid list mode parse should raise error message" do
-    #   editor_json = set_items("invalid-mode", [])
-    #   {:ok, editor_string} = Jason.encode(editor_json)
-    #   {:error, err_msg} = Parser.to_html(editor_string)
+    @tag :wip2
+    test "invalid table field parse should raise error message" do
+      editor_json = set_items("aa", "bb")
+      {:ok, editor_string} = Jason.encode(editor_json)
+      {:error, err_msg} = Parser.to_html(editor_string)
 
-    #   assert err_msg == [
-    #            %{
-    #              block: "list",
-    #              field: "mode",
-    #              message: "should be: checklist | order_list | unorder_list"
-    #            }
-    #          ]
-    # end
+      assert err_msg = [
+               %{
+                 block: "table",
+                 field: "columnCount",
+                 message: "should be: number",
+                 value: "aa"
+               },
+               %{block: "table", field: "items", message: "should be: list", value: "bb"}
+             ]
+    end
   end
 end