refactor(editor): add spec-type && clean up

Author: mydearxym

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

@@ -9,7 +9,7 @@ defmodule Helper.Converter.EditorToHTML.Frags.List do
 
   @class get_in(Class.article(), ["list"])
 
-  @spec get_item(:checklist | :unorder_list | :order_list, map) :: T.html()
+  @spec get_item(:checklist | :unorder_list | :order_list, T.editor_list_item()) :: T.html()
   def get_item(:unorder_list, %{
         "hideLabel" => hide_label,
         "indent" => indent,
@@ -76,6 +76,16 @@ defmodule Helper.Converter.EditorToHTML.Frags.List do
       </div>)
   end
 
+  @spec frag(:label, T.editor_list_label_type(), T.editor_list_indent(), String.t()) :: T.html()
+  def frag(:label, label_type, indent, label) do
+    label_class = @class["label"]
+    label_type_class = @class["label__#{label_type}"]
+
+    ~s(<div class="#{label_class} #{label_type_class}" data-index="#{indent}">
+        #{label}
+      </div>)
+  end
+
   @spec frag(:unorder_list_prefix) :: T.html()
   def frag(:unorder_list_prefix) do
     unorder_list_prefix_class = @class["unorder_list_prefix"]
@@ -90,15 +100,6 @@ defmodule Helper.Converter.EditorToHTML.Frags.List do
     ~s(<div class="#{order_list_prefix_class}">#{prefix_index}</div>)
   end
 
-  def frag(:label, label_type, indent, label) do
-    label_class = @class["label"]
-    label_type_class = @class["label__#{label_type}"]
-
-    ~s(<div class="#{label_class} #{label_type_class}" data-index="#{indent}">
-        #{label}
-      </div>)
-  end
-
   @spec frag(:checkbox, Boolean.t()) :: T.html()
   def frag(:checkbox, checked) when is_boolean(checked) do
     checked_svg = svg(:checked)
@@ -123,6 +124,7 @@ defmodule Helper.Converter.EditorToHTML.Frags.List do
       </div>)
   end
 
+  @spec frag(:checkbox, :text, String.t()) :: T.html()
   def frag(:checkbox, :text, text) do
     text_class = @class["checklist_text"]
 

lib/helper/types.ex

@@ -39,6 +39,27 @@ defmodule Helper.Types do
         }
 
   @typedoc """
+  valid editor.js's list item indent
+  """
+  @type editor_list_indent :: 0 | 1 | 2 | 3
+
+  @typedoc """
+  valid editor.js's list item label type
+  """
+  @type editor_list_label_type :: :default | :red | :green | :warn
+
+  @typedoc """
+  editor.js's list item for order_list | unorder_list | checklist
+  """
+  @type editor_list_item :: %{
+          required(:hideLabel) => String.t(),
+          required(:indent) => editor_list_indent,
+          required(:label) => String.t(),
+          required(:labelType) => editor_list_label_type,
+          required(:text) => String.t(),
+          prefixIndex: String.t()
+        }
+  @typedoc """
   html fragment
   """
   @type html :: String.t()

test/helper/converter/editor_to_html_test/list_test.exs

@@ -27,7 +27,6 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       }
     end
 
-    @tag :wip2
     test "basic list parse should work" do
       editor_json =
         set_items("unorder_list", [
@@ -148,8 +147,6 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.List do
       {:ok, editor_string} = Jason.encode(editor_json)
       {:ok, converted} = Parser.to_html(editor_string)
 
-      IO.inspect(converted, label: "the converted")
-
       checked_class = @class["checklist_checkbox_checked"]
       assert Utils.str_occurence(converted, checked_class) == 1
     end