shahryarjb

shahryarjb

Create @behaviour and @type with macro

Hi, I have Elixir macro that I want to use it as @behaviour in my project. but there is a problem I can not be able to use a @type as a parameters of a macro.

My macro

defmodule MishkaPub.ActivityStream.Validator do
  defmacro __using__(opts) do
    quote(bind_quoted: [opts: opts]) do
      type = Keyword.get(opts, :type)
      module = Keyword.get(opts, :module)

      @type t :: unquote(type)
      @type action() :: :build | :validate

      @callback build(t()) :: {:ok, action(), t()} | {:error, action(), any()}
      @callback build(t(), list(String.t())) ::
                  {:ok, action(), t()} | {:error, action(), any()}

      @callback validate(t()) :: {:ok, action(), t()} | {:error, action(), any()}
      @callback validate(t(), list(String.t())) ::
                  {:ok, action(), t()} | {:error, action(), any()}

      @behaviour unquote(module)
    end
  end
end

And the Elixir file I want to use it

defmodule MishkaPub.ActivityStream.Type.Object do
  alias MishkaPub.ActivityStream.Validator

  @type tt :: %__MODULE__{
          id: String.t(),
          type: String.t(),
          name: String.t(),
          replies: list(String.t())
        }

  defstruct [
    :id,
    :type,
    ..
  ]

  use Validator, module: __MODULE__, type: tt()

  def build(%__MODULE__{} = params) do
    {:ok, :build, Map.merge(%__MODULE__{}, params)}
  rescue
    _e ->
      {:ok, :build, :unexpected}
  end

  ...
end

but I have this error

** (CompileError) lib/activity_stream/validator.ex:3: undefined function type/0 (there is no such import)

How can fix this error?


Another problem if this is fixed! I have 2 duplicated types. (tt(), t()) but I just want to have one type which should be t()

Thank you in advance :rose: :pray:

Marked As Solved

christhekeele

christhekeele

The folk in this thread are providing solid advice to improve your approach, which I would recommend following and would resolve your issues.

However, to address the specific cause of this error the way you are doing things today, for learning about Elixir metaprogramming:

You have an unquoting issue in your macro. Take just the lines here:

You have a variable, opts, inside of your macro’s context, containing a keyword list. To make that available to your generated code, you have to unquote it—which you have implicitly via bind_quoted, no problem!

That means that the variable you next introduce, type, is only available in the generated code. So when you proceed to unquote(type), you are getting the equivalent of variable type does not exists—since it does not exist inside the macro’s context.

You have 3 options:

  1. Unquote opts and extract the type exclusively in the generated code context:

    defmacro(__using__(opts) do
      quote(bind_quoted: [opts: opts]) do
        type = Keyword.get(opts, :type)
        @type t :: type
      end
    end
    
  2. Extract the type exclusively in the macro context and unquote in the generate code:

    defmacro(__using__(opts) do
      type = Keyword.fetch!(opts, :type)
      quote do
        @type t :: unquote(type)
      end
    end
    
    
  3. Extract the type exclusively in the macro context and bind_quoted:

    defmacro(__using__(opts) do
      type = Keyword.fetch!(opts, :type)
      quote [bind_quoted: [type: type]] do
        @type t :: type
      end
    end
    

I believe the 3rd option is popular, although personally I tend to prefer the second, as I like to be explicit about my opts munging and unquote-ing.

Also Liked

hst337

hst337

  1. Please note that @callback attribute is set in the module which defines the interface. While @behaviour is set in the module which implements the interface.

  2. So you’ll actually need something like this

defmodule MishkaPub.ActivityStream.Validator do
  @type action() :: :build | :validate
  @type t :: any() # Or what kind of argument Validator generally wants

  @callback build(t()) :: {:ok, action(), t()} | {:error, action(), any()}
  @callback build(t(), list(String.t())) ::
            {:ok, action(), t()} | {:error, action(), any()}

  @callback validate(t()) :: {:ok, action(), t()} | {:error, action(), any()}
  @callback validate(t(), list(String.t())) ::
            {:ok, action(), t()} | {:error, action(), any()}
end

defmodule MishkaPub.ActivityStream.Type.Object do
  alias MishkaPub.ActivityStream.Validator

  @type t :: %__MODULE__{
          id: String.t(),
          type: String.t(),
          name: String.t(),
          replies: list(String.t())
        }

  defstruct [
    :id,
    :type,
    ..
  ]

  @behaviour Validator

  @impl true
  @spec build(t()) :: {:ok, Validator.action(), t()} | {:error, Validator.action(), any()}
  def build(%__MODULE__{} = params) do
    {:ok, :build, Map.merge(%__MODULE__{}, params)}
  rescue
    _e ->
      {:ok, :build, :unexpected}
  end

  ...
end
al2o3cr

al2o3cr

+1 to what @hst337 said, the behaviour and the implementation need to be separate modules.

Some other thoughts:

  • passing __MODULE__ isn’t required, the module that said use is available as __MODULE__ inside the quote block.

    defmodule MacroDemo do
      defmacro __using__(opts) do
        IO.inspect(__MODULE__, label: "outside")
    
        quote(bind_quoted: [opts: opts]) do
          IO.inspect(__MODULE__, label: "inside")
        end
      end
    end
    
    defmodule Foo do
      use MacroDemo
    end
    
    # prints
    outside: MacroDemo
    inside: Foo
    
  • apart from failing to compile, the only thing that type in Validator does is define t. What about just expecting the user to write @type t :: etc etc etc outside of the use and then using it in the @callbacks?

shahryarjb

shahryarjb

Thank you it is very good to know how to do.

Where Next?

Popular in Questions Top

electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
RisingFromAshes
I’ve read in another post that it may be possible with a router helper - but I couldn’t find an appropriate one, and tbh, I’m still just ...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
aadeshere1
I have a another noob question about loop. Since elixir is immutable, while loop is not directly possible. total = 10 while total != 0 ...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
svb
Hi! Currently I want to submit a form by pressing the Enter key. However, since my input field is of type “textarea” this is just adds a...
New

Other popular topics Top

rms.mrcs
Hi, I need to transform a list of numbers into a map where the keys are the indexes and the values are the original values of the list. ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
chrismccord
Phoenix 1.4.0 released Phoenix 1.4 is out! This release ships with exciting new features, most notably with HTTP2 support, improved deve...
688 31586 112
New
sen
Hi All, I set a environment variables in dev.exs , like below code. when i start server, how can i set the ${enable} value? thanks. d...
New
AstonJ
Seen any cool LiveView demos, sample apps or examples? Please post them here! :003:
New
siddhant3030
Hi, I have to write a raw query for one of my project. But till now I have used ecto queries and don’t have much experience writing raw ...
New

We're in Beta

About us Mission Statement