rename library, add package metadata

hansihe · hansihe · commit e46932f93e9f · 2017-01-24T22:49:29.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -20,3 +20,5 @@ erl_crash.dump
 *.ez
 
 /priv/native
+
+/native/*/target
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Html5everErlang
+# Html5ever binding for Elixir
 
-NIF wrapper of html5ever using Rustler.
+NIF binding of html5ever using Rustler.
 
 It is currently functional, but missing some features and optimization.
 
diff --git a/lib/html5ever.ex b/lib/html5ever.ex
@@ -1,4 +1,4 @@
-defmodule ExHtml5ever do
+defmodule Html5ever do
   @moduledoc """
   Documentation for ExHtml5ever.
   """
@@ -11,7 +11,7 @@ defmodule ExHtml5ever do
   end
 
   defp parse_async(html) do
-    ExHtml5ever.Native.parse_async(html)
+    Html5ever.Native.parse_async(html)
     receive do
       {:html5ever_nif_result, :ok, result} ->
         {:ok, result}
@@ -21,7 +21,7 @@ defmodule ExHtml5ever do
   end
 
   defp parse_sync(html) do
-    case ExHtml5ever.Native.parse_sync(html) do
+    case Html5ever.Native.parse_sync(html) do
       {:html5ever_nif_result, :ok, result} ->
         {:ok, result}
       {:html5ever_nif_result, :error, err} ->
diff --git a/lib/html5ever/native.ex b/lib/html5ever/native.ex
@@ -2,8 +2,8 @@ defmodule NifNotLoadedError do
   defexception message: "nif not loaded"
 end
 
-defmodule ExHtml5ever.Native do
-  use Rustler, otp_app: :ex_html5ever, crate: "html5ever_nif"
+defmodule Html5ever.Native do
+  use Rustler, otp_app: :html5ever, crate: "html5ever_nif"
 
   def parse_async(binary), do: err()
   def parse_sync(binary), do: err()
diff --git a/mix.exs b/mix.exs
@@ -1,15 +1,17 @@
-defmodule ExHtml5ever.Mixfile do
+defmodule Html5ever.Mixfile do
   use Mix.Project
 
   def project do
-    [app: :ex_html5ever,
+    [app: :html5ever,
      version: "0.1.0",
      elixir: "~> 1.4",
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
      compilers: [:rustler] ++ Mix.compilers(),
      rustler_crates: rustler_crates(),
-     deps: deps()]
+     deps: deps(),
+     description: description(),
+     package: package()]
   end
 
   def rustler_crates do
@@ -19,7 +21,8 @@ defmodule ExHtml5ever.Mixfile do
         cargo: :system,
         default_features: false,
         features: [],
-        mode: :release,#(if Mix.env == :prod, do: :release, else: :debug),
+        mode: :release,
+        # mode: (if Mix.env == :prod, do: :release, else: :debug),
       ]
     ]
   end
@@ -42,6 +45,23 @@ defmodule ExHtml5ever.Mixfile do
   #
   # Type "mix help deps" for more examples and options
   defp deps do
-    [{:rustler, "~> 0.6"}]
+    [{:rustler, "~> 0.6"},
+     {:ex_doc, ">= 0.0.0", only: :dev}]
   end
+
+  defp description do
+    """
+    NIF binding of html5ever using rustler.
+    """
+  end
+
+  defp package do
+    [
+      files: ["lib", "native", "mix.exs", "README.md"],
+      maintainers: ["hansihe"],
+      licenses: ["MIT", "Apache-2.0"],
+      links: %{"GitHub" => "https://github.com/hansihe/html5ever_elixir"},
+    ]
+  end
+
 end
diff --git a/mix.lock b/mix.lock
@@ -1 +1,3 @@
-%{"rustler": {:hex, :rustler, "0.6.0", "ba67a5e3d662876f2bf7ef5478bb3be03a7baa40e96950456526fdee29673530", [:mix], []}}
+%{"earmark": {:hex, :earmark, "1.1.0", "8c2bf85d725050a92042bc1edf362621004d43ca6241c756f39612084e95487f", [:mix], []},
+  "ex_doc": {:hex, :ex_doc, "0.14.5", "c0433c8117e948404d93ca69411dd575ec6be39b47802e81ca8d91017a0cf83c", [:mix], [{:earmark, "~> 1.0", [hex: :earmark, optional: false]}]},
+  "rustler": {:hex, :rustler, "0.6.0", "ba67a5e3d662876f2bf7ef5478bb3be03a7baa40e96950456526fdee29673530", [:mix], []}}
diff --git a/native/html5ever_nif/src/lib.rs b/native/html5ever_nif/src/lib.rs
@@ -247,7 +247,7 @@ fn parse_sync<'a>(env: NifEnv<'a>, args: &Vec<NifTerm<'a>>) -> NifResult<NifTerm
 }
 
 rustler_export_nifs!(
-    "Elixir.ExHtml5ever.Native",
+    "Elixir.Html5ever.Native",
     [("parse_async", 1, parse_async),
      ("parse_sync", 1, parse_sync)],
     Some(on_load)
diff --git a/test/ex_html5ever_test.exs b/test/ex_html5ever_test.exs
diff --git a/test/html5ever_test.exs b/test/html5ever_test.exs
@@ -0,0 +1,31 @@
+defmodule Html5everTest do
+  use ExUnit.Case
+  doctest Html5ever
+
+  def read_html(name) do
+    dir = to_string(:code.priv_dir(:html5ever)) <> "/test_data/"
+    File.read!(dir <> name)
+  end
+
+  test "parse basic html" do
+    html = "<html><head></head><body></body></html>"
+    ret = {:ok, [{"html", [], [{"head", [], []}, {"body", [], []}]}]}
+    assert Html5ever.parse(html) == ret
+  end
+
+  test "parse example.com html" do
+    html = read_html("example.html")
+    assert match?({:ok, _}, Html5ever.parse(html))
+  end
+
+  test "parse drudgereport.com html" do
+    html = read_html("drudgereport.html")
+    assert match?({:ok, _}, Html5ever.parse(html))
+  end
+
+  test "unbalanced worst case" do
+    html = String.duplicate("<div>", 100)
+    assert match?({:ok, _}, Html5ever.parse(html))
+  end
+
+end

Original file line number	Diff line number	Diff line change
`@@ -247,7 +247,7 @@ fn parse_sync<'a>(env: NifEnv<'a>, args: &Vec<NifTerm<'a>>) -> NifResult<NifTerm`
`247`	`247`	`}`
`248`	`248`
`249`	`249`	`rustler_export_nifs!(`
`250`		`- "Elixir.ExHtml5ever.Native",`
	`250`	`+ "Elixir.Html5ever.Native",`
`251`	`251`	`[("parse_async", 1, parse_async),`
`252`	`252`	`("parse_sync", 1, parse_sync)],`
`253`	`253`	`Some(on_load)`