refactor(article): rm metric module, add class module

Author: mydearxym

lib/helper/metric/article.ex renamed to lib/helper/converter/editor_to_html/class.ex

@@ -1,4 +1,4 @@
-defmodule Helper.Metric.Article do
+defmodule Helper.Converter.EditorToHTML.Class do
   @moduledoc """
   html article class names parsed from editor.js's json data
 
@@ -9,7 +9,7 @@ defmodule Helper.Metric.Article do
   @doc """
   get all the class names of the parsed editor.js's html parts
   """
-  def class_names(:html) do
+  def article() do
     %{
       # root wrapper
       "viewer" => "article-viewer-wrapper",

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

@@ -4,10 +4,11 @@ defmodule Helper.Converter.EditorToHTML.Frags.Header do
 
   see https://editorjs.io/
   """
-  alias Helper.Metric
   alias Helper.Types, as: T
 
-  @class get_in(Metric.Article.class_names(:html), ["header"])
+  alias Helper.Converter.EditorToHTML.Class
+
+  @class get_in(Class.article(), ["header"])
 
   @spec get(T.editor_header()) :: T.html()
   def get(%{"eyebrowTitle" => eyebrow_title, "footerTitle" => footer_title} = data) do

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

@@ -4,9 +4,9 @@ defmodule Helper.Converter.EditorToHTML.Frags.List do
 
   see https://editorjs.io/
   """
-  alias Helper.Metric
+  alias Helper.Converter.EditorToHTML.Class
 
-  @class get_in(Metric.Article.class_names(:html), ["list"])
+  @class get_in(Class.article(), ["list"])
 
   def get_item(:checklist, %{
         "checked" => checked,

lib/helper/converter/editor_to_html/header.ex

@@ -9,10 +9,9 @@ defmodule Helper.Converter.EditorToHTML.Header do
 
   defmacro __using__(_opts) do
     quote do
-      alias Helper.Metric
-      alias Helper.Converter.EditorToHTML.Frags
+      alias Helper.Converter.EditorToHTML.{Class, Frags}
 
-      @class get_in(Metric.Article.class_names(:html), ["header"])
+      @class get_in(Class.article(), ["header"])
 
       defp parse_block(%{"type" => "header", "data" => data}) do
         Frags.Header.get(data)

lib/helper/converter/editor_to_html/index.ex

@@ -13,16 +13,16 @@ defmodule Helper.Converter.EditorToHTML do
   """
 
   use Helper.Converter.EditorToHTML.{Header, Paragraph, List}
+  alias Helper.Types, as: T
 
-  alias Helper.{Metric, Utils}
+  alias Helper.Utils
   alias Helper.Converter.{EditorToHTML, HtmlSanitizer}
-  alias EditorToHTML.Validator
+  alias EditorToHTML.{Class, Validator}
 
   # alias EditorToHTML.Assets.{DelimiterIcons}
+  @root_class Class.article()
 
-  @root_class Metric.Article.class_names(:html)
-
-  @spec to_html(binary | maybe_improper_list) :: false | {:ok, <<_::64, _::_*8>>}
+  @spec to_html(String.t()) :: T.ok_html()
   def to_html(string) when is_binary(string) do
     with {:ok, parsed} = string_to_json(string),
          {:ok, _} <- Validator.is_valid(parsed) do

lib/helper/converter/editor_to_html/list.ex

@@ -9,10 +9,9 @@ defmodule Helper.Converter.EditorToHTML.List do
 
   defmacro __using__(_opts) do
     quote do
-      alias Helper.Metric
-      alias Helper.Converter.EditorToHTML.Frags
+      alias Helper.Converter.EditorToHTML.{Class, Frags}
 
-      # @class get_in(Metric.Article.class_names(:html), "list")
+      # @class get_in(Class.article(), ["list"])
 
       defp parse_block(%{"type" => "list", "data" => data}) do
         %{"items" => items} = data

lib/helper/converter/editor_to_html/paragraph.ex

@@ -6,8 +6,6 @@ defmodule Helper.Converter.EditorToHTML.Paragraph do
   """
   defmacro __using__(_opts) do
     quote do
-      # alias Helper.Metric
-
       defp parse_block(%{"type" => "paragraph", "data" => %{"text" => text}}) do
         "<p>#{text}</p>"
       end

lib/helper/types.ex

@@ -42,4 +42,5 @@ defmodule Helper.Types do
   html fragment
   """
   @type html :: String.t()
+  @type ok_html :: {:ok, String.t()}
 end

test/helper/converter/editor_to_html_test/header_test.exs

@@ -3,11 +3,10 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML.Header do
 
   use GroupherServerWeb.ConnCase, async: true
 
-  alias Helper.Metric
   alias Helper.Converter.EditorToHTML, as: Parser
-  alias Helper.Converter.EditorToHTML.Frags
+  alias Helper.Converter.EditorToHTML.{Class, Frags}
 
-  @root_class Metric.Article.class_names(:html)
+  @root_class Class.article()
 
   describe "[header block unit]" do
     @editor_json %{

test/helper/converter/editor_to_html_test/index_test.exs

@@ -3,13 +3,13 @@ defmodule GroupherServer.Test.Helper.Converter.EditorToHTML do
 
   use GroupherServerWeb.ConnCase, async: true
 
-  alias Helper.Metric
+  alias Helper.Converter.EditorToHTML.Class
   alias Helper.Converter.EditorToHTML, as: Parser
 
   #   "<addr class="cdx-lock">hello</addr> Editor.js <mark class="cdx-marker">workspace</mark>. is an element &lt;script&gt;alert("hello")&lt;/script&gt;"
 
   #   "text" : "<script>evil scripts</script>"
-  @root_class Metric.Article.class_names(:html)
+  @root_class Class.article()
 
   @real_editor_data ~S({
     "time" : 1567250876713,