CharlesO

CharlesO

I’m looking to improve this pattern.
It is a pattern I use in a lot of my projects.

defmodule Handler do
    def handle_request(data) do
        response = apply(@some_module_from_config, :parse, [data])

        # do_something_with_response(response)
        ...
    end
end

I then have customer specific implementations of :parse in separate modules, for example

defmodule CustomerA do
    def parse(data) do
        # specific parsing of this data for Customer-A
    end
end

defmodule CustomerB do
    def parse(data) do
         # specific parsing of this data for Customer-B
    end
end

This works, but can it be improved?

Is there a benefit for example to have a @behaviour in Handler which defines :parse and other functions

Then each Customer module no implements use Handler

Please are their better patterns for doing this?

Thanks.

Marked As Solved

D4no0

D4no0

Nope, all you need is something like this:

defmodule ParseBehavior do
  # Obviously replace any with your data types
  @callback parse(data :: any) :: any
end

defmodule CustomerA do
  @behaviour ParseBehavior 
end

If you don’t implement the specified callbacks you will get a compilation warning.

You can also have the variant with the default implementation:

defmodule ParseBehavior do
  @callback parse(data :: any) :: any

  defmacro __using__(_opts) do
    quote do
      @behaviour ParseBehavior
      
      def parse(data) do
        # This will be the default implementation if not overriden
      end

     defoverridable parse: 1
    end
  end
end

defmodule CustomerA do
   use ParseBehavior

  # This definition will override the default definition
  def parse(data) do
   
  end
end

I wouldn’t recommend using the variant with default implementation unless that is strictly required, as it makes the code harder to read.

Also Liked

al2o3cr

al2o3cr

The major benefit is compile-time checking:

  • if CustomerA says @behaviour Handler but doesn’t supply callbacks with the correct arities, the compiler will complain
  • (sometimes) Dialyzer will be able to prove that a function’s implementation fails to match the behaviour’s spec

As a side bonus, libraries like mox can use that same behaviour for their definitions.

Eiji

Eiji

No need to use apply as it’s much more useful if you have function name stored in variable.

`        response = @some_module_from_config.parse(data)`

Not only it would not give you any benefit, but it would also be wrongly used.

In Handler module you have to define callbacks and / or macrocallbacks. You use @behaviour attribute in CustomerA and CustomerB modules. In this tiny example it’s not important at all, but in general you use this to make sure that all callbacks are implemented as Elixir gives compilation warning otherwise.

egze

egze

I also recommend watching the keynote from José https://www.youtube.com/watch?v=agkXUp0hCW8
He goes into the topic what to use when.

Last Post!

D4no0

D4no0

You can’t, the module that defines behavior whole point is to make sure that you are implementing the required functions, it’s up to you how you call them afterwards.

You can either use the pattern you are already using with apply/3 or you can call directly the function, as module names are just plain atoms:

my_modules = [CustomerA, CustomerB]
for module <- my_modules do
  module.parse(data)
end

You could add some compile-time checks to ensure that the module you are calling has the behavior declared, but I don’t see a lot of value from that.

Where Next? Top

Trending in Questions Top

RSP87
I’m working on a project that simulates the bumbl example in the programming phoenix book. It acts almost like an email client. We have a...
New
nseaSeb
Hello, I know there is an approach for handling lists that allows for optimized traversal, but I can’t recall the specific method (somet...
New
RemyXRenard
I’m seeing that a list inside a Kino.DataTable will be interpreted as a charlist, even if the Kino.configure() is set to charlists: :as_l...
New
velrest
So my question is quite simple and i have found no conclusive answer on forum, google or AI. Should we use :erlang.float for Integer to ...
New
brecabral
Documentation While reading the Scoped Routes section, I noticed that the documentation currently refers to a problem without explainin...
New
samoloth
Hi, I’ve just set up an application with ash_authentication. There is only magic link strategy for now, so there is no confirmation add o...
New
FlyingNoodle
If a change or preparation module uses Ash.Changeset.get_argument/2 or Ash.Query.get_argument/2 (or any of the other get_argument functio...
New

Other Trending Topics Top

mudasobwa
I am happy to introduce the very α version of the new programming language compiled to BEAM. Welcome Cure. It has literally three kille...
New
marciok
Hi there! We created Gust: A task orchestrator inspired by Airflow. For those who have never heard about Aiflow, it’s a Python-based wor...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Dmk
Xamal is a deployment tool for Elixir apps that deploys native releases to bare metal servers over SSH. It’s a port of GitHub - basecamp/...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
webofbits
With AI doing more of the implementation work, I’ve been wondering how much coding I should deliberately keep doing myself. My main conc...
#ai
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews