rebrand Myhtmlex module to :fast_html part 1

a2a685a5 · Ariadne Conill · 564532c0 · a2a685a5 · a2a685a5 · a2a685a5
Commit a2a685a5 authored Nov 06, 2019 by Ariadne Conill
Hide whitespace changes
Inline Side-by-side

Showing with 41 additions and 41 deletions

Makefile Makefile +17 -17

lib/fast_html.ex lib/fast_html.ex +10 -10

test/fast_html_test.exs test/fast_html_test.exs +14 -14

No files found.
--- a/Makefile
+++ b/Makefile
 MIX = mix
-MYHTMLEX_CFLAGS = -g -O2 -std=c99 -pedantic -Wcomment -Wextra -Wno-old-style-declaration -Wall
+MYHTML_WORKER_CFLAGS = -g -O2 -std=c99 -pedantic -Wcomment -Wextra -Wno-old-style-declaration -Wall
 # we need to compile position independent code
-MYHTMLEX_CFLAGS += -fpic -DPIC
+MYHTML_WORKER_CFLAGS += -fpic -DPIC
 # For some reason __erl_errno is undefined unless _REENTRANT is defined
-MYHTMLEX_CFLAGS += -D_REENTRANT
+MYHTML_WORKER_CFLAGS += -D_REENTRANT
 # myhtmlex is using stpcpy, as defined in gnu string.h
-# MYHTMLEX_CFLAGS += -D_GNU_SOURCE
+# MYHTML_WORKER_CFLAGS += -D_GNU_SOURCE
 # base on the same posix c source as myhtml
-# MYHTMLEX_CFLAGS += -D_POSIX_C_SOURCE=199309
+# MYHTML_WORKER_CFLAGS += -D_POSIX_C_SOURCE=199309
 # turn warnings into errors
-# MYHTMLEX_CFLAGS += -Werror
+# MYHTML_WORKER_CFLAGS += -Werror
 # ignore unused variables
-# MYHTMLEX_CFLAGS += -Wno-unused-variable
+# MYHTML_WORKER_CFLAGS += -Wno-unused-variable
 # ignore unused parameter warnings
-MYHTMLEX_CFLAGS += -Wno-unused-parameter
+MYHTML_WORKER_CFLAGS += -Wno-unused-parameter

 # set erlang include path
 ERLANG_PATH = $(shell erl -eval 'io:format("~s", [lists:concat([code:root_dir(), "/erts-", erlang:system_info(version)])])' -s init stop -noshell)
-MYHTMLEX_CFLAGS += -I$(ERLANG_PATH)/include
+MYHTML_WORKER_CFLAGS += -I$(ERLANG_PATH)/include

 # expecting myhtml as a submodule in c_src/
 # that way we can pin a version and package the whole thing in hex
 # hex does not allow for non-app related dependencies.
 MYHTML_PATH = c_src/myhtml
 MYHTML_STATIC = $(MYHTML_PATH)/lib/libmyhtml_static.a
-MYHTMLEX_CFLAGS += -I$(MYHTML_PATH)/include
+MYHTML_WORKER_CFLAGS += -I$(MYHTML_PATH)/include
 # avoid undefined reference errors to phtread_mutex_trylock
-MYHTMLEX_CFLAGS += -lpthread
+MYHTML_WORKER_CFLAGS += -lpthread

 # that would be used for a dynamically linked build
-# MYHTMLEX_CFLAGS += -L$(MYHTML_PATH)/lib
+# MYHTML_WORKER_CFLAGS += -L$(MYHTML_PATH)/lib

-MYHTMLEX_LDFLAGS = -shared
+MYHTML_WORKER_LDFLAGS = -shared

 # C-Node
 ERL_INTERFACE = $(wildcard $(ERLANG_PATH)/../lib/erl_interface-*)
-CNODE_CFLAGS = $(MYHTMLEX_CFLAGS)
+CNODE_CFLAGS = $(MYHTML_WORKER_CFLAGS)
 CNODE_CFLAGS += -L$(ERL_INTERFACE)/lib
 CNODE_CFLAGS += -I$(ERL_INTERFACE)/include

@@ -55,12 +55,12 @@ BUILD_TESTS := $(patsubst %.dockerfile, %.dockerfile.PHONY, $(wildcard ./build-t
 # platform specific environment
 UNAME = $(shell uname -s)
 ifeq ($(UNAME_S),Darwin)
-    MYHTMLEX_LDFLAGS += -dynamiclib -undefined dynamic_lookup
+    MYHTML_WORKER_LDFLAGS += -dynamiclib -undefined dynamic_lookup
 else
    # myhtmlex is using stpcpy, as defined in gnu string.h
-    MYHTMLEX_CFLAGS += -D_GNU_SOURCE
+    MYHTML_WORKER_CFLAGS += -D_GNU_SOURCE
    # base on the same posix c source as myhtml
-    # MYHTMLEX_CFLAGS += -D_POSIX_C_SOURCE=199309
+    # MYHTML_WORKER_CFLAGS += -D_POSIX_C_SOURCE=199309
 endif

 .PHONY: all

--- a/lib/myhtmlex.ex
+++ b/lib/myhtmlex.ex
-defmodule Myhtmlex do
+defmodule :fast_html do
  @moduledoc """
  A module to decode html into a tree structure.

@@ -7,7 +7,7 @@ defmodule Myhtmlex do

  ## Example

-      iex> Myhtmlex.decode("<h1>Hello world</h1>")
+      iex> :fast_html.decode("<h1>Hello world</h1>")
      {"html", [], [{"head", [], []}, {"body", [], [{"h1", [], ["Hello world"]}]}]}

  Benchmark results (removed Nif calling mode) on various file sizes on a 2,5Ghz Core i7:
@@ -46,18 +46,18 @@ defmodule Myhtmlex do

  ## Examples

-      iex> Myhtmlex.decode("<h1>Hello world</h1>")
+      iex> :fast_html.decode("<h1>Hello world</h1>")
      {"html", [], [{"head", [], []}, {"body", [], [{"h1", [], ["Hello world"]}]}]}

-      iex> Myhtmlex.decode("<span class='hello'>Hi there</span>")
+      iex> :fast_html.decode("<span class='hello'>Hi there</span>")
      {"html", [],
       [{"head", [], []},
        {"body", [], [{"span", [{"class", "hello"}], ["Hi there"]}]}]}

-      iex> Myhtmlex.decode("<body><!-- a comment --!></body>")
+      iex> :fast_html.decode("<body><!-- a comment --!></body>")
      {"html", [], [{"head", [], []}, {"body", [], [comment: " a comment "]}]}

-      iex> Myhtmlex.decode("<br>")
+      iex> :fast_html.decode("<br>")
      {"html", [], [{"head", [], []}, {"body", [], [{"br", [], []}]}]}
  """
  @spec decode(String.t()) :: tree()
@@ -78,17 +78,17 @@ defmodule Myhtmlex do

  ## Examples

-      iex> Myhtmlex.decode("<h1>Hello world</h1>", format: [:html_atoms])
+      iex> :fast_html.decode("<h1>Hello world</h1>", format: [:html_atoms])
      {:html, [], [{:head, [], []}, {:body, [], [{:h1, [], ["Hello world"]}]}]}

-      iex> Myhtmlex.decode("<br>", format: [:nil_self_closing])
+      iex> :fast_html.decode("<br>", format: [:nil_self_closing])
      {"html", [], [{"head", [], []}, {"body", [], [{"br", [], nil}]}]}

-      iex> Myhtmlex.decode("<body><!-- a comment --!></body>", format: [:comment_tuple3])
+      iex> :fast_html.decode("<body><!-- a comment --!></body>", format: [:comment_tuple3])
      {"html", [], [{"head", [], []}, {"body", [], [{:comment, [], " a comment "}]}]}

      iex> html = "<body><!-- a comment --!><unknown /></body>"
-      iex> Myhtmlex.decode(html, format: [:html_atoms, :nil_self_closing, :comment_tuple3])
+      iex> :fast_html.decode(html, format: [:html_atoms, :nil_self_closing, :comment_tuple3])
      {:html, [],
       [{:head, [], []},
        {:body, [], [{:comment, [], " a comment "}, {"unknown", [], nil}]}]}

--- a/test/myhtmlex.safe_test.exs
+++ b/test/myhtmlex.safe_test.exs
-defmodule Myhtmlex.SafeTest do
+defmodule :fast_html_test do
  use ExUnit.Case
-  doctest Myhtmlex
+  doctest :fast_html

  test "doesn't segfault when <!----> is encountered" do
-    assert {"html", _attrs, _children} = Myhtmlex.decode("<div> <!----> </div>")
+    assert {"html", _attrs, _children} = :fast_html.decode("<div> <!----> </div>")
  end

  test "builds a tree, formatted like mochiweb by default" do
@@ -14,7 +14,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 {"br", [], []}
               ]}
-            ]} = Myhtmlex.decode("<br>")
+            ]} = :fast_html.decode("<br>")
  end

  test "builds a tree, html tags as atoms" do
@@ -25,7 +25,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 {:br, [], []}
               ]}
-            ]} = Myhtmlex.decode("<br>", format: [:html_atoms])
+            ]} = :fast_html.decode("<br>", format: [:html_atoms])
  end

  test "builds a tree, nil self closing" do
@@ -37,7 +37,7 @@ defmodule Myhtmlex.SafeTest do
                 {"br", [], nil},
                 {"esi:include", [], nil}
               ]}
-            ]} = Myhtmlex.decode("<br><esi:include />", format: [:nil_self_closing])
+            ]} = :fast_html.decode("<br><esi:include />", format: [:nil_self_closing])
  end

  test "builds a tree, multiple format options" do
@@ -48,7 +48,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 {:br, [], nil}
               ]}
-            ]} = Myhtmlex.decode("<br>", format: [:html_atoms, :nil_self_closing])
+            ]} = :fast_html.decode("<br>", format: [:html_atoms, :nil_self_closing])
  end

  test "attributes" do
@@ -60,7 +60,7 @@ defmodule Myhtmlex.SafeTest do
                 {:span, [{"id", "test"}, {"class", "foo garble"}], []}
               ]}
            ]} =
-             Myhtmlex.decode(~s'<span id="test" class="foo garble"></span>',
+             :fast_html.decode(~s'<span id="test" class="foo garble"></span>',
               format: [:html_atoms]
             )
  end
@@ -74,7 +74,7 @@ defmodule Myhtmlex.SafeTest do
                 {:button, [{"disabled", "disabled"}, {"class", "foo garble"}], []}
               ]}
            ]} =
-             Myhtmlex.decode(~s'<button disabled class="foo garble"></span>',
+             :fast_html.decode(~s'<button disabled class="foo garble"></span>',
               format: [:html_atoms]
             )
  end
@@ -87,7 +87,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 "text node"
               ]}
-            ]} = Myhtmlex.decode(~s'<body>text node</body>', format: [:html_atoms])
+            ]} = :fast_html.decode(~s'<body>text node</body>', format: [:html_atoms])
  end

  test "broken input" do
@@ -98,7 +98,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 {:a, [{"<", "<"}], [" asdf"]}
               ]}
-            ]} = Myhtmlex.decode(~s'<a <> asdf', format: [:html_atoms])
+            ]} = :fast_html.decode(~s'<a <> asdf', format: [:html_atoms])
  end

  test "namespaced tags" do
@@ -113,7 +113,7 @@ defmodule Myhtmlex.SafeTest do
                    {"svg:a", [], []}
                  ]}
               ]}
-            ]} = Myhtmlex.decode(~s'<svg><path></path><a></a></svg>', format: [:html_atoms])
+            ]} = :fast_html.decode(~s'<svg><path></path><a></a></svg>', format: [:html_atoms])
  end

  test "custom namespaced tags" do
@@ -124,7 +124,7 @@ defmodule Myhtmlex.SafeTest do
               [
                 {"esi:include", [], nil}
               ]}
-            ]} = Myhtmlex.decode(~s'<esi:include />', format: [:html_atoms, :nil_self_closing])
+            ]} = :fast_html.decode(~s'<esi:include />', format: [:html_atoms, :nil_self_closing])
  end

  test "html comments" do
@@ -135,6 +135,6 @@ defmodule Myhtmlex.SafeTest do
               [
                 comment: " a comment "
               ]}
-            ]} = Myhtmlex.decode(~s'<body><!-- a comment --></body>', format: [:html_atoms])
+            ]} = :fast_html.decode(~s'<body><!-- a comment --></body>', format: [:html_atoms])
  end
 end