Merge pull request #4 from juulSme/master

Update stuff, release with Github Actions

Author: Thomas-Jean

.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: CI
+
+on:
+  push:
+    branches: ["*"]
+
+env:
+  MIX_ENV: test
+
+jobs:
+  test:
+    name: OTP ${{ matrix.otp }} / Elixir ${{ matrix.elixir }} / Rust ${{ matrix.rust }}
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        elixir: ["1.12", "1.13", "1.14"]
+        otp: ["23", "24", "25"]
+        rust: ["stable"]
+        exclude:
+          - elixir: "1.14"
+            otp: "24"
+          - elixir: "1.13"
+            otp: "25"
+          - elixir: "1.12"
+            otp: "25"
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp }}
+          elixir-version: ${{ matrix.elixir }}
+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          override: true
+      - name: Cache Elixir deps
+        uses: actions/cache@v3
+        with:
+          path: |
+            deps
+            _build
+          key: deps-cache-${{ matrix.elixir }}-${{ matrix.otp }}-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            deps-cache-${{ matrix.elixir }}-${{ matrix.otp }}-
+      - name: Cache Rust deps
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+          key: ${{ matrix.rust }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ matrix.rust }}-cargo-
+      - name: Install elixir dependencies
+        run: mix do local.hex --force, local.rebar --force, deps.get
+      - name: Check code formatting
+        run: mix format --check-formatted
+      - name: Compile dependencies
+        run: mix deps.compile
+      - name: Compile code (warnings as errors)
+        run: mix compile --warnings-as-errors
+      - name: Run tests
+        run: mix test
+      - name: Create docs
+        run: mix docs

.github/workflows/main.yml

@@ -0,0 +1,52 @@
+name: Release
+on:
+  release:
+    types: [released]
+
+jobs:
+  release:
+    name: Publish release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Display build environment
+        run: printenv
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set version in readme
+        uses: weareyipyip/set-version-action@v2
+        with:
+          source: tag
+          file_path: README.md
+      - name: Set version in mix.exs
+        uses: weareyipyip/set-version-action@v2
+        with:
+          source: tag
+          file_path: mix.exs
+      - name: Set version in Cargo.toml
+        uses: weareyipyip/set-version-action@v2
+        with:
+          source: tag
+          file_path: native/blake3/Cargo.toml
+      - name: Set version in Cargo.lock
+        uses: weareyipyip/set-version-action@v2
+        with:
+          source: tag
+          file_path: native/blake3/Cargo.lock
+
+      - uses: erlef/setup-beam@v1
+        with:
+          otp-version: "25"
+          elixir-version: "1.14"
+      - name: Install dependencies
+        run: mix do local.hex --force, local.rebar --force, deps.get
+
+      - name: Compile code
+        run: mix compile
+      - name: Create docs
+        run: mix docs
+      - name: Publish release
+        run: mix hex.publish --yes
+        env:
+          HEX_API_KEY: ${{ secrets.HEX_API_KEY }}

.github/workflows/release.yml

@@ -1,5 +1,31 @@
 # Changelog
 
+## v0.6.0
+
+- Enhancements
+
+  - updated blake3 version to 1.3.3
+  - updated rustler to 0.22.2
+
+- Other
+  - add github actions release workflow
+  - fix CI
+  - Release version injection
+
+## v0.5.0 (unreleased)
+
+- Enhancements
+
+  - updated blake3 version to 1.0.0
+  - updated rustler to 0.22.1
+  - refactored Rust crate to use the rustler::nif macro
+
+- Breaking changes
+
+  - `update_with_join` has been replacted with `update_rayon` to reflect the
+    same change in the upstream `blake3` crate. This function is only available
+    when the `rayon` feature flag is enabled, and will panic otherwise.
+
 ## v0.4.0
 
 - Enhancements

CHANGELOG.md

@@ -12,7 +12,7 @@ The package can be installed by adding `blake3` to your list of dependencies in
 ```elixir
 def deps do
   [
-    {:blake3, "~> 0.4.1"}
+    {:blake3, "~> 0.0.0+development"}
   ]
 end
 ```
@@ -21,7 +21,7 @@ run `mix deps.get` and `mix deps.compile` to pull and build the bindings
 
 ## Configuration
 
-There are feature options in the rust implementation that allow for additional SIMD instructions and multithreading. They can be set though environment variable or `Mix.Config`. 
+There are feature options in the rust implementation that allow for additional SIMD instructions and multithreading. They can be set though environment variable or `Mix.Config`.
 
 ```shell
 export BLAKE3_SIMD_MODE=neon
@@ -36,8 +36,8 @@ config :blake3,
    rayon: :true
 ```
 
-* `neon` enables ARM NEON support
-* `rayon` enables Rayon-based multithreading
+- `neon` enables ARM NEON support
+- `rayon` enables Rayon-based multithreading
 
 When changing configuration you will need to call `mix deps.compile` to enable the features.
 
@@ -54,4 +54,9 @@ When changing configuration you will need to call `mix deps.compile` to enable t
 #"a74bb4d1d4e44d0a2981d131762f45db9a211313d8e9f2cd151b4e673a35a6c1"
 ```
 
+## Supported Elixir / Erlang / Rust
+
+We follow Rustler itself, supporting latest three minor Elixir versions and major OTP versions.
+As for Rust itself, we only support stable.
+
 Documentation can found at [https://hexdocs.pm/blake3](https://hexdocs.pm/blake3).

README.md

@@ -1,3 +1,7 @@
-use Mix.Config
-# config :blake3, simd_mode: "std"
-# config :blake3, rayon: :false
+import Config
+
+config :blake3, Blake3.Native,
+  mode: :release,
+  features: MixBlake3.Project.config_features()
+
+import_config("#{Mix.env()}.exs")

config/config.exs

@@ -0,0 +1 @@
+import Config

config/dev.exs

@@ -0,0 +1,3 @@
+import Config
+
+config :blake3, Blake3.Native, features: ~w(rayon)

config/test.exs

@@ -6,9 +6,12 @@ defmodule Blake3 do
 
   alias Blake3.Native
 
+  @type hasher :: reference()
+
   @doc """
   computes a message digest for the given data
   """
+  @spec hash(data :: binary()) :: binary()
   def hash(data) do
     Native.hash(data)
   end
@@ -19,6 +22,7 @@ defmodule Blake3 do
   diffrent size you can use `derive_key` to get a key of
   a proper size.
   """
+  @spec keyed_hash(key :: binary(), data :: binary()) :: binary() | {:error, String.t()}
   def keyed_hash(key, data) when byte_size(key) == 32 do
     Native.keyed_hash(key, data)
   end
@@ -31,6 +35,7 @@ defmodule Blake3 do
   returns a new reference for a Blake3 hasher to be used
   for streaming calls with update/2
   """
+  @spec new() :: hasher()
   def new() do
     Native.new()
   end
@@ -39,6 +44,7 @@ defmodule Blake3 do
   returns a new reference for a Blake3 hasher using the passed key
   to be used for streaming calls with update/2
   """
+  @spec new_keyed(key :: binary()) :: hasher() | {:error, String.t()}
   def new_keyed(key) when byte_size(key) == 32 do
     Native.new_keyed(key)
   end
@@ -52,6 +58,7 @@ defmodule Blake3 do
   the refernce can be continouly passed to update/2 or
   when finished to finalize/1
   """
+  @spec update(state :: hasher(), data :: binary()) :: hasher()
   def update(state, data) do
     Native.update(state, data)
   end
@@ -60,28 +67,32 @@ defmodule Blake3 do
   returns the binary of the current hash state for a
   given hasher
   """
+  @spec finalize(state :: hasher()) :: binary()
   def finalize(state) do
     Native.finalize(state)
   end
 
   @doc """
   returns a 32 byte key for use for `hash_keyed` or `new_keyed` from
-  the given context and key. for more information: [crate](https://github.com/BLAKE3-team/BLAKE3#the-blake3-crate)
+  the given context and key. for more information: [crate](https://github.com/BLAKE3-team/BLAKE3#the-blake3-crate-)
   """
+  @spec derive_key(context :: binary(), key :: binary()) :: binary()
   def derive_key(context, key) do
     Native.derive_key(context, key)
   end
 
   @doc """
   same as `derive_key/2` but uses an empty string for context
   """
+  @spec derive_key(key :: binary()) :: binary()
   def derive_key(key) do
     Native.derive_key("", key)
   end
 
   @doc """
   reset a hasher to the default stat like when calling Blake3.new
   """
+  @spec derive_key(state :: hasher()) :: hasher()
   def reset(state) do
     Native.reset(state)
   end
@@ -90,9 +101,10 @@ defmodule Blake3 do
   updates state with the potential to multithreading. The rayon
   feature needs to be enabled and the input need to be large enough.
   for more information see:
-  [comment](https://github.com/BLAKE3-team/BLAKE3/blob/fdd329ba57896faac4ae797775c175ad880cbe42/src/lib.rs#L948-L981)
+  [documentation](https://docs.rs/blake3/1.0.0/blake3/struct.Hasher.html#method.update_rayon)
   """
-  def update_with_join(state, data) do
-    Native.update_with_join(state, data)
+  @spec update_rayon(state :: hasher(), data :: binary()) :: hasher()
+  def update_rayon(state, data) do
+    Native.update_rayon(state, data)
   end
 end

lib/blake3.ex

@@ -4,12 +4,13 @@ defmodule Blake3.Native do
   This module doesn't need to be called direcly.
   """
 
-  use Rustler, otp_app: :blake3, crate: :blake3
+  use Rustler,
+    otp_app: :blake3
 
   def hash(_str), do: error()
   def new(), do: error()
   def update(_state, _str), do: error()
-  def update_with_join(_state, _str), do: error()
+  def update_rayon(_state, _str), do: error()
   def finalize(_state), do: error()
   def derive_key(_context, _key), do: error()
   def keyed_hash(_key, _str), do: error()