Add specs

danschultzer · Apr 15, 2018 · efa2281 · efa2281
1 parent e5665e4
commit efa2281
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/lib/premailex.ex b/lib/premailex.ex
@@ -12,6 +12,7 @@ defmodule Premailex do
       "<html><head><style>p{background-color: #fff;}</style></head><body><p style=\\\"background-color:#fff;color:#000;\\\">Text</p></body></html>"
 
   """
+  @spec to_inline_css(String.t()) :: String.t()
   def to_inline_css(html) do
     Premailex.HTMLInlineStyles.process(html)
   end
@@ -25,6 +26,7 @@ defmodule Premailex do
       "Text"
 
   """
+  @spec to_text(String.t()) :: String.t()
   def to_text(html) do
     html
     |> Floki.find("body")

diff --git a/lib/premailex/css_parser.ex b/lib/premailex/css_parser.ex
@@ -3,6 +3,9 @@ defmodule Premailex.CSSParser do
   Module that handles CSS parsing with naive Regular Expression.
   """
 
+  @type rule :: %{directive: String.t(), value: String.t(), important?: boolean}
+  @type rule_set :: %{rules: [rule], selector: String.t(), specificity: number}
+
   @css_selector_rules ~r/([\s\S]*?){([\s\S]*?)}/mi
 
   @non_id_attributes_and_pseudo_classes ~r/
@@ -45,6 +48,7 @@ defmodule Premailex.CSSParser do
          selector: "body",
          specificity: 1}]
   """
+  @spec parse(String.t()) :: [rule_set]
   def parse(""), do: []
 
   def parse(css) do
@@ -79,6 +83,7 @@ defmodule Premailex.CSSParser do
       [%{directive: "background-color", value: "#fff", important?: false},
        %{directive: "color", value: "red", important?: false}]
   """
+  @spec parse_rules(String.t()) :: [rule]
   def parse_rules(rules) do
     rules
     |> String.split(";")
@@ -116,10 +121,12 @@ defmodule Premailex.CSSParser do
 
   ## Examples
 
-      iex> "p {background-color: #fff !important; color: #000;} p {background-color: #000;}" |> Premailex.CSSParser.parse() |> Premailex.CSSParser.merge()
+      iex> rule_sets = Premailex.CSSParser.parse("p {background-color: #fff !important; color: #000;} p {background-color: #000;}")
+      iex> Premailex.CSSParser.merge(rule_sets)
       [%{directive: "background-color", value: "#fff !important", important?: true, specificity: 1},
        %{directive: "color", value: "#000", important?: false, specificity: 1}]
   """
+  @spec merge([rule_set]) :: [rule_set]
   def merge(rule_sets) do
     rule_sets
     |> Enum.map(fn rule_set ->
@@ -165,6 +172,7 @@ defmodule Premailex.CSSParser do
       iex> Premailex.CSSParser.to_string(%{directive: "background-color", value: "#fff"})
       "background-color:#fff;"
   """
+  @spec to_string([rule]) :: String.t()
   def to_string(rules) when is_list(rules),
     do: Enum.reduce(rules, "", &"#{&2}#{__MODULE__.to_string(&1)}")
 

diff --git a/lib/premailex/html_inline_styles.ex b/lib/premailex/html_inline_styles.ex
@@ -6,6 +6,7 @@ defmodule Premailex.HTMLInlineStyles do
   alias Premailex.{CSSParser, HTMLParser, Util}
 
   @doc false
+  @spec process(String.t()) :: String.t()
   def process(html) do
     tree = HTMLParser.parse(html)
 

diff --git a/lib/premailex/html_to_plain_text.ex b/lib/premailex/html_to_plain_text.ex
@@ -2,7 +2,6 @@ defmodule Premailex.HTMLToPlainText do
   @moduledoc """
   Module that converts HTML emails to plain text.
   """
-
   alias Premailex.Util
 
   @doc """
@@ -14,6 +13,7 @@ defmodule Premailex.HTMLToPlainText do
       "* Test"
 
   """
+  @spec process(String.t() | Util.html_tree()) :: String.t()
   def process(html) when is_binary(html), do: html |> Floki.parse() |> process()
 
   def process(html) do