Skip to main content

Ecto "inheritance" using macros

Oooh them's fighting words. Anyways, this is definitely not true inheritance by any means, but let me explain the problem and then the solution.

Ecto is the primary way you connect to the database in Phoenix. However, Ecto differs in many significant ways from ActiveRecord in Rails. You can set up a schema file which lists the relationships between your "models" or "entities", but these schemas do not allow you to directly access the database. They are merely descriptions of how the data is expressed.

To access the database, you need to use a data context which uses Ecto.

So, from my article comparing Active Record to Ecto (http://www.skuunk.com/2020/01/comparing-rails-active-record-pattern.html)


defmodule Schema.Article do
  use Ecto.Schema
  import Ecto.Changeset

  alias Schema.Author
  alias Schema.Comment

  @permitted_fields [:title, :content]
  @required_fields [:title, :content]

  schema "article" do
    belongs_to(:author, Author)
    has_many(:comments, Comment)
    field(:title, :string)
    field(:content, :string)

    timestamps()
  end

  def changeset(article, params) do
    article
    |> cast(params, @permitted_fields)
    |> validate_required(@required_fields)
  end
end

defmodule Context.Articles do
  import Ecto.Query, warn: false
  alias Context.Repo

  alias Schema.Article

  def find(id) do
    Repo.get(Article, id)
  end

  ...
  #implement other data access methods as required
  ...
end
This is all well and good and it does work, however you will soon discover that there are some very common methods you will need over and over again. Basically the CRUD operations (Create, Read, Update and Delete) but you might also have some other common variations (for example you can find by id or find by other attributes).

Wouldn't it be nice if like in Rails, you could just "inherit" these methods on all your contexts so you would not have to write a custom find method each time. Well, using macros you can!

In Elixir, macros are the metaprogramming framework which allows you to basically use code to write code. In fact the if function in Elixir is basically a macro.

On top of macros, you need to know how to use code from other files. Read up on the use macro for more details. https://elixir-lang.org/getting-started/alias-require-and-import.html#use

Anyways, let's maybe start with the code and then explain it later...


defmodule Services.Data.Common do
  defmacro __using__(values) do
    schema = Keyword.get(values, :schema)

    quote bind_quoted: [schema: schema] do
      require Ecto.Query
      alias Ecto.Query
      alias Services.Repos.Repo
      @schema schema

      def find(id) when is_atom(preloads) or is_list(preloads) do
        @schema
        |> Repo.get(id)
      end

      # ... more common database functions
    end
  end
end

This is a common data services module. Any functions you create in here will filter through to any other modules that use it. In fact this is how we import the Ecto.Schema functionality into our Schema module.

To use this, we will call it from the Context module


defmodule Context.Articles do
  import Ecto.Query, warn: false
  alias Context.Repo

  alias Schema.Article

  use Services.Data.Common, schema: Articles

end

As you can see, we were able to remove the find function from Articles as it is using Common. We are passing the schema into the macro so that we can also use this macro with Author or Comment (or any other schema).

Okay, so this is really not inheritance, it's composition, but it has the same net effect. When you compile this, essentially we are adding all these functions to the data contexts.

The one major difference from inheritance is you cannot then override find from inside your own context (you will have to give it a different name I am afraid).

So a little more explanation might be needed. Importing a module with the use macro not only imports the functions, but also calls the __using__ function. Calling the quote function inserts all this code into the virtual version of your module. bind_quoted allows you to make sure that the variables you pass in are available at runtime (and are not precompiled). In this case, we want to make sure the schema can be passed in at runtime so it is in fact variable.

And that is how a little metaprogramming can go a long way.

Comments

Popular posts from this blog

Master of my domain

Hi All, I just got myself a new domain ( http://www.skuunk.com ). The reason is that Blogspot.com is offering cheap domain via GoDaddy.com and I thought after having this nickname for nigh on 10 years it was time to buy the domain before someone else did (also I read somewhere that using blogspot.com in your domain is the equivalent of an aol.com or hotmail.com email address...shudder...). Of course I forgot that I would have to re-register my blog everywhere (which is taking ages) not to mention set up all my stats stuff again. *sigh*. It's a blogger's life... In any case, don't forget to bookmark the new address and to vote me up on Technorati !

Speeding up RSpec

So today I have been looking into getting our enormous battery of tests to run faster. I have yet to find anything that works for Cucumber, but I did find an interesting way to speed up RSpec which is detailed here. https://makandracards.com/makandra/950-speed-up-rspec-by-deferring-garbage-collection Basically, it seems that by not collecting garbage too frequently, you can make your tests run much faster (at the expense of memory management of course). We observed a 30% reduction in the time it takes to run an RSpec test suite. I did try to implement this on Cucumber, however because we need to store much more in memory to set up and tear down our objects, it meant that I kept running out of memory when I wasn't using the default Garbage Collection and the tests took even longer (so, buyer beware). I suppose if you had a small set of features though you might see some benefit.

Elixir - destructuring, function overloading and pattern matching

Why am I covering 3 Elixir topics at once? Well, perhaps it is to show you how the three are used together. Individually, any of these 3 are interesting, but combined, they provide you with a means of essentially getting rid of conditionals and spaghetti logic. Consider the following function. def greet_beatle(person) do case person.first_name do "John" -> "Hello John." "Paul" -> "Good day Paul." "George" -> "Georgie boy, how you doing?" "Ringo" -> "What a drummer!" _-> "You are not a Beatle, #{person.first_name}" end end Yeah, it basically works, but there is a big old case statement in there. If you wanted to do something more as well depending on the person, you could easily end up with some spaghetti logic. Let's see how we can simplify this a little. def greet_beatle(%{first_name: first_name}) do case first_name d