Mix.install/2を用いてElixirライブラリの使い方を多数掲載しているmix_install_examplesが面白い
Thinking Elixir Podcast 103で紹介されていたwojtekmach/mix_install_examplesというリポジトリが面白いです。これは、Mix.install/2を用いて、様々なライブラリの使い方を示しているリポジトリです。
PhoenixやEctoなどの有名なものから、Elixirのコード内にCのコードを組み込めるwojtekmach/cや、libffi経由で共有ライブラリのコードをElixirから呼び出せるcocoa-xu/otterのようなものまで、いろいろなライブラリの簡単な使い方が紹介されています。
実例
Phoenix LiveView
以下は、mix_install_examples/phoenix_live_view.exsを転載したものです。
Phoenixを使ったアプリケーションは、雛形があれこれ生成されて最初から複雑なものになりますが、こうやって本質的な部分だけ抜き出して示されると、その仕組みがよくわかります。
Application.put_env(:phoenix, :json_library, Jason)
Application.put_env(:sample, SamplePhoenix.Endpoint,
http: [ip: {127, 0, 0, 1}, port: 5001],
server: true,
live_view: [signing_salt: "aaaaaaaa"],
secret_key_base: String.duplicate("a", 64)
)
Mix.install([
{:plug_cowboy, "~> 2.5"},
{:jason, "~> 1.0"},
{:phoenix, "~> 1.6.10"},
{:phoenix_live_view, "~> 0.17.10"}
])
defmodule SamplePhoenix.ErrorView do
use Phoenix.View, root: ""
def render(_, _), do: "error"
end
defmodule SamplePhoenix.SampleLive do
use Phoenix.LiveView, layout: {__MODULE__, "live.html"}
def mount(_params, _session, socket) do
{:ok, assign(socket, :count, 0)}
end
def render("live.html", assigns) do
~H"""
<script src="https://cdn.jsdelivr.net/npm/phoenix@1.6.10/priv/static/phoenix.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/phoenix_live_view@0.17.10/priv/static/phoenix_live_view.min.js"></script>
<script>
let liveSocket = new window.LiveView.LiveSocket("/live", window.Phoenix.Socket)
liveSocket.connect()
</script>
<style>
* { font-size: 1.1em; }
</style>
<%= @inner_content %>
"""
end
def render(assigns) do
~H"""
<%= @count %>
<button phx-click="inc">+</button>
<button phx-click="dec">-</button>
"""
end
def handle_event("inc", _params, socket) do
{:noreply, assign(socket, :count, socket.assigns.count + 1)}
end
def handle_event("dec", _params, socket) do
{:noreply, assign(socket, :count, socket.assigns.count - 1)}
end
end
defmodule Router do
use Phoenix.Router
import Phoenix.LiveView.Router
pipeline :browser do
plug(:accepts, ["html"])
end
scope "/", SamplePhoenix do
pipe_through(:browser)
live("/", SampleLive, :index)
end
end
defmodule SamplePhoenix.Endpoint do
use Phoenix.Endpoint, otp_app: :sample
socket("/live", Phoenix.LiveView.Socket)
plug(Router)
end
{:ok, _} = Supervisor.start_link([SamplePhoenix.Endpoint], strategy: :one_for_one)
Process.sleep(:infinity)
TypeCheck
前述のThinking Elixirのエピソードで紹介されていた、Elixirに実行時の型チェック機能を追加するライブラリTypeCheckが面白かったので、さっそく同じ形式で使い方を記述するpull requestを送ってみたところ、すぐにマージしてもらえました(Add an example for type_check package by kentaro · Pull Request #12 · wojtekmach/mix_install_examples)。
こんな内容です(mix_install_examples/type_check.exs)。
Mix.install([
{:type_check, "~> 0.10.0"}
])
ExUnit.start()
defmodule User do
use TypeCheck
defstruct [:name, :age]
@type! t :: %User{name: binary, age: integer}
end
defmodule AgeCheck do
use TypeCheck
@spec! user_older_than?(User.t, integer) :: boolean
def user_older_than?(user, age) do
user.age >= age
end
end
defmodule TypeCheckTest do
use ExUnit.Case, async: true
test "passes type check" do
assert AgeCheck.user_older_than?(%User{name: "Qqwy", age: 11}, 10)
end
test "doesn't pass type check" do
assert_raise TypeCheck.TypeError, fn ->
AgeCheck.user_older_than?("foobar", 42)
end
end
end
おわりに
それにしてもMix.install/2
って便利ですね。Mix.install/2
については、「Elixir 1.12で追加されたMix.install/2の使い道」という記事も書いたりしています。あわせてご覧ください。
Discussion