Merge pull request #121 from mischov/chore/update-meeseeks-html5ever

Precompile NIFs

Author: mischov

.github/workflows/tests.yml renamed to .github/workflows/ci.yml

@@ -1,26 +1,29 @@
-name: tests
+name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["**"]
 
 jobs:
-  check-elixir-formatting:
-    name: Check Elixir formatting
+  check-formatting:
+    name: Check formatting
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Set up Elixir
         uses: erlef/setup-beam@v1
         with:
-          otp-version: '24.0'
-          elixir-version: '1.12.0'
+          otp-version: 25.0
+          elixir-version: 1.14
 
-      - name: Check formatting
+      - name: Check Elixir formatting
         run: mix format --check-formatted
 
   test-elixir:
-    name: Test with OTP ${{ matrix.otp }} and Elixir ${{ matrix.elixir }}
-    runs-on: ubuntu-latest
+    name: Test Elixir ${{ matrix.elixir }} / OTP ${{ matrix.otp }}
 
     env:
       MIX_ENV: test
@@ -29,49 +32,29 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - otp: '21.0'
-            elixir: '1.7.0'
-          - otp: '21.0'
-            elixir: '1.11.0'
-          - otp: '22.0'
-            elixir: '1.7.0'
-          - otp: '22.0'
-            elixir: '1.11.0'
-          - otp: '23.0'
-            elixir: '1.10.3'
-          - otp: '23.0'
-            elixir: '1.12.0'
-          - otp: '24.0'
-            elixir: '1.11.4'
-          - otp: '24.0'
-            elixir: '1.12.0'
+          - elixir: 1.12
+            otp: 23
+          - elixir: 1.13
+            otp: 24
+          - elixir: 1.14
+            otp: 25
+
+    # TODO change this to ubuntu-latest after OTP 23 is deprecated, see
+    # https://github.com/erlef/setup-beam#compatibility-between-operating-system-and-erlangotp
+    # for compatibility
+    runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Rust
-        uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          override: true
+      - uses: actions/checkout@v3
 
       - name: Set up Elixir
         uses: erlef/setup-beam@v1
         with:
           otp-version: ${{ matrix.otp }}
           elixir-version: ${{ matrix.elixir }}
 
-      - name: Retrieve cached Rust dependencies
-        uses: actions/cache@v2
-        id: cargo-cache
-        with:
-          path: ~/.cargo
-          key: ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-cargo-${{ hashFiles(format('{0}{1}', github.workspace, '/mix.lock')) }}
-          restore-keys: |
-             ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-cargo-
-
       - name: Retrieve cached Elixir dependencies
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         id: mix-cache
         with:
           path: deps
@@ -80,7 +63,7 @@ jobs:
             ${{ runner.os }}-${{ matrix.otp }}-${{ matrix.elixir }}-mix-
 
       - name: Retrieve cached Elixir build
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         id: build-cache
         with:
           path: _build

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+### Compatibility
+
+  * No longer support Elixir versions under 1.12 or Erlang/OTP versions under 23.0
+  * Support Elixir 1.13 and 1.14 and Erlang/OTP 25.0
+
+### Enhancements
+
+  * Update to `meeseeks_html5ever v0.14.3`, which supports NIF precompilation
+
 ## v0.16.1 (2021-10-20)
 
 ### Compatibility

README.md

@@ -35,15 +35,13 @@ end
 
 ## Compatibility
 
-Meeseeks requires a minimum combination of Elixir 1.7.0 and Erlang/OTP 21, and has been tested with a maximum combination of Elixir 1.12.0 and Erlang/OTP 24.0.
+Meeseeks requires a minimum combination of Elixir 1.12.0 and Erlang/OTP 23.0, and is tested with a maximum combination of Elixir 1.14.0 and Erlang/OTP 25.0.
 
 ## Installation
 
-Meeseeks depends on [html5ever](https://github.com/servo/html5ever) via [meeseeks_html5ever](https://github.com/mischov/meeseeks_html5ever).
+Meeseeks depends on the Rust library [`html5ever`](https://github.com/servo/html5ever) via [`meeseeks_html5ever`](https://github.com/mischov/meeseeks_html5ever), but because `meeseeks_html5ever` provides pre-compiled NIFs via [`rustler_precompiled`](https://github.com/philss/rustler_precompiled) **you do not need to have Rust installed** to use Meeseeks.
 
-Because html5ever is a Rust library, you will need to have the Rust compiler [installed](https://www.rust-lang.org/tools/install) wherever Meeseeks is compiled.
-
-Ensure Rust is installed, then add Meeseeks to your `mix.exs`:
+To install Meeseeks, add it to your `mix.exs`:
 
 ```elixir
 defp deps do
@@ -53,7 +51,11 @@ defp deps do
 end
 ```
 
-Finally, run `mix deps.get`.
+Then run `mix deps.get`.
+
+### Force Compilation
+
+If you need to force compilation of the Rust NIF for some reason, see the instructions [here](https://github.com/mischov/meeseeks_html5ever#dependencies).
 
 ## Getting Started
 

config/config.exs

@@ -32,33 +32,16 @@ defmodule Meeseeks.Mixfile do
 
   defp deps do
     [
-      {:meeseeks_html5ever, "~> 0.13.1"},
+      {:meeseeks_html5ever, "~> 0.14.3"},
 
-      # dev
+      # Dev
       {:dialyxir, "~> 0.5", only: :dev, runtime: false},
 
-      # docs
+      # Docs
       {:ex_doc, "~> 0.24.0", only: :docs, runtime: false}
     ]
   end
 
-  defp package do
-    [
-      maintainers: ["Mischov"],
-      licenses: ["MIT"],
-      files: [
-        "lib",
-        "src/*.xrl",
-        "src/*.yrl",
-        "mix.exs",
-        "README.md",
-        "LICENSE",
-        "LICENSE-APACHE"
-      ],
-      links: %{"GitHub" => @source_url}
-    ]
-  end
-
   defp docs do
     [
       markdown_processor: ExDoc.Markdown.Meeseeks,
@@ -81,4 +64,21 @@ defmodule Meeseeks.Mixfile do
       ]
     ]
   end
+
+  defp package do
+    [
+      maintainers: ["Mischov"],
+      licenses: ["MIT"],
+      files: [
+        "lib",
+        "src/*.xrl",
+        "src/*.yrl",
+        "mix.exs",
+        "README.md",
+        "LICENSE",
+        "LICENSE-APACHE"
+      ],
+      links: %{"GitHub" => @source_url}
+    ]
+  end
 end

mix.exs

@@ -1,5 +1,6 @@
 %{
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
+  "castore": {:hex, :castore, "1.0.1", "240b9edb4e9e94f8f56ab39d8d2d0a57f49e46c56aced8f873892df8ff64ff5a", [:mix], [], "hexpm", "b4951de93c224d44fac71614beabd88b71932d0b1dea80d2f80fb9044e01bbb3"},
   "credo": {:hex, :credo, "0.6.1", "a941e2591bd2bd2055dc92b810c174650b40b8290459c89a835af9d59ac4a5f8", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}], "hexpm"},
   "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], [], "hexpm", "7c5c6c1eceb93e26a06c36148cb6f8021ae6f4f9a07bb1ae95f588e0a01ea8e1"},
   "earmark": {:hex, :earmark, "1.4.3", "364ca2e9710f6bff494117dbbd53880d84bebb692dafc3a78eb50aa3183f2bfd", [:mix], [], "hexpm", "8cf8a291ebf1c7b9539e3cddb19e9cef066c2441b1640f13c34c1d3cfc825fec"},
@@ -11,8 +12,9 @@
   "makeup_elixir": {:hex, :makeup_elixir, "0.15.1", "b5888c880d17d1cc3e598f05cdb5b5a91b7b17ac4eaf5f297cb697663a1094dd", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.1", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "db68c173234b07ab2a07f645a5acdc117b9f99d69ebf521821d89690ae6c6ec8"},
   "makeup_erlang": {:hex, :makeup_erlang, "0.1.1", "3fcb7f09eb9d98dc4d208f49cc955a34218fc41ff6b84df7c75b3e6e533cc65f", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "174d0809e98a4ef0b3309256cbf97101c6ec01c4ab0b23e926a9e17df2077cbb"},
   "markdown": {:git, "https://github.com/devinus/markdown.git", "d065dbcc4e242a85ca2516fdadd0082712871fd8", []},
-  "meeseeks_html5ever": {:hex, :meeseeks_html5ever, "0.13.1", "31f6b743b3dd15587a5f74804a14737fa3297ac57cb366bfeda507e003f6b61f", [:mix], [{:rustler, "~> 0.22.0", [hex: :rustler, repo: "hexpm", optional: false]}], "hexpm", "c2689ff90d0a5b345e85a163c20110545978e22aa66348e178fb0cce0efa16d7"},
+  "meeseeks_html5ever": {:hex, :meeseeks_html5ever, "0.14.3", "7827c6ce393d9f99dd0220c356fd66ee7101718037ec6f7f18d4bcba84ef1798", [:mix], [{:rustler, ">= 0.0.0", [hex: :rustler, repo: "hexpm", optional: true]}, {:rustler_precompiled, "~> 0.6.1", [hex: :rustler_precompiled, repo: "hexpm", optional: false]}], "hexpm", "6b69573b97120fcc6e97045178ad085fd3ee10a5b49c1e9ebb8a28bd4a9c538b"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.1.0", "3a6fca1550363552e54c216debb6a9e95bd8d32348938e13de5eda962c0d7f89", [:mix], [], "hexpm", "08eb32d66b706e913ff748f11694b17981c0b04a33ef470e33e11b3d3ac8f54b"},
   "rustler": {:hex, :rustler, "0.22.2", "f92d6dba71bef6fe5f0d955649cb071127adc92f32a78890e8fa9939e59a1b41", [:mix], [{:jason, "~> 1.2", [hex: :jason, repo: "hexpm", optional: false]}, {:toml, "~> 0.5.2", [hex: :toml, repo: "hexpm", optional: false]}], "hexpm", "56b129141e86d60a2d670af9a2b55a9071e10933ef593034565af77e84655118"},
+  "rustler_precompiled": {:hex, :rustler_precompiled, "0.6.1", "160b545bce8bf9a3f1b436b2c10f53574036a0db628e40f393328cbbe593602f", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "0dd269fa261c4e3df290b12031c575fff07a542749f7b0e8b744d72d66c43600"},
   "toml": {:hex, :toml, "0.5.2", "e471388a8726d1ce51a6b32f864b8228a1eb8edc907a0edf2bb50eab9321b526", [:mix], [], "hexpm", "f1e3dabef71fb510d015fad18c0e05e7c57281001141504c6b69d94e99750a07"},
 }