koudelka / behaves_like

Instant Elixir behaviours, creates callbacks from specs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

BehavesLike

Build Status Hex pm

Turns a module's specs into callbacks.

Lets you state that a module behaves like another, without writing behaviour callbacks.

Uses a macro for 1.7, until elixir-lang/elixir#8085 is fixed.

For example:

defmodule API do
  use BehavesLike
  import BehavesLike, only: [spec_and_callback: 1]

  spec_and_callback get(binary()) :: {:ok, any()} | {:error, any()}
  def get(id) do
    Backend.get(id)
  end
end

defmodule Backend do
  @behaviour API

  @impl true
  def get(id) do
    database().get(id)
  end
end

Installation

From Hex:

def deps do
  [
    {:behaves_like, "~> 0.5.0"}
  ]
end

Usage

Import the required macro, then declare your specs with spec_and_callback/1, as in the example above.

About

Instant Elixir behaviours, creates callbacks from specs.

License:MIT License


Languages

Language:Elixir 100.0%