Χορεύουσες κουκκίδες

Χρήση

Το macro use μάς επιτρέπει να επεκτείνουμε γρήγορα το module μας με λειτουργικότητα που παρέχει ένα άλλο module. Όταν κάνουμε use ένα module, αυτό το module μπορεί να εισάγει κώδικα στο module μας: μπορεί για παράδειγμα να ορίσει συναρτήσεις, να κάνει import ή alias άλλα modules, ή να ορίσει χαρακτηριστικά του module.

Αν έχεις κοιτάξει ποτέ τα αρχεία test κάποιων από τις ασκήσεις Elixir εδώ στο Exercism, πιθανότατα πρόσεξες ότι όλα ξεκινούν με use ExUnit.Case. Αυτή η μία γραμμή κώδικα είναι που κάνει τα macros test και assert διαθέσιμα στο module test.

defmodule LasagnaTest do
  use ExUnit.Case

  test "expected minutes in oven" do
    assert Lasagna.expected_minutes_in_oven() === 40
  end
end

Το macro __using__/1

Το τι ακριβώς συμβαίνει όταν κάνεις use ένα module το υπαγορεύει το macro __using__/1 αυτού του module. Παίρνει ένα όρισμα, μια λίστα λέξεων-κλειδιών με επιλογές, και επιστρέφει μια παρατιθέμενη έκφραση. Ο κώδικας σε αυτήν την παρατιθέμενη έκφραση εισάγεται στο module μας όταν καλούμε το use.

defmodule ExUnit.Case do
  defmacro __using__(opts) do
    # some real-life ExUnit code omitted here
    quote do
      import ExUnit.Assertions
      import ExUnit.Case, only: [describe: 2, test: 1, test: 2, test: 3]
    end
  end
end

Οι επιλογές μπορούν να δοθούν ως δεύτερο όρισμα όταν καλείς το use, π.χ. use ExUnit.Case, async: true. Όταν δεν δίνονται ρητά, προεπιλέγονται σε μια κενή λίστα.

Συμπεριφορές

Οι συμπεριφορές μάς επιτρέπουν να ορίσουμε διεπαφές (σύνολα συναρτήσεων και macros) σε ένα module συμπεριφοράς, τις οποίες μπορούν αργότερα να υλοποιήσουν διαφορετικά modules callback. Χάρη στην κοινή διεπαφή, αυτά τα modules callback μπορούν να χρησιμοποιούνται εναλλακτικά.

Ορισμός συμπεριφορών

Για να ορίσουμε μια συμπεριφορά, χρειάζεται να δημιουργήσουμε ένα νέο module και να προσδιορίσουμε μια λίστα συναρτήσεων που αποτελούν μέρος της επιθυμητής διεπαφής. Κάθε συνάρτηση πρέπει να ορίζεται με το χαρακτηριστικό module @callback. Η σύνταξη είναι ίδια με ένα typespec συνάρτησης (@spec). Χρειάζεται να προσδιορίσουμε ένα όνομα συνάρτησης, μια λίστα με τους τύπους των ορισμάτων και όλους τους πιθανούς τύπους επιστροφής.

defmodule Countable do
  @callback count(collection :: any) :: pos_integer
end

Υλοποίηση συμπεριφορών

Για να προσθέσουμε μια υπάρχουσα συμπεριφορά στο module μας (να δημιουργήσουμε ένα module callback) χρησιμοποιούμε το χαρακτηριστικό module @behaviour. Η τιμή του πρέπει να είναι το όνομα του module συμπεριφοράς που προσθέτουμε.

Έπειτα, χρειάζεται να ορίσουμε όλες τις συναρτήσεις (callbacks) που απαιτεί αυτό το module συμπεριφοράς. Αν υλοποιούμε τη συμπεριφορά κάποιου άλλου, όπως τις ενσωματωμένες συμπεριφορές Access ή GenServer της Elixir, θα βρούμε τη λίστα όλων των callbacks της συμπεριφοράς στην τεκμηρίωση στο hexdocs.pm.

Ένα module callback δεν περιορίζεται στην υλοποίηση μόνο των συναρτήσεων που αποτελούν μέρος της συμπεριφοράς του. Είναι επίσης δυνατό ένα μόνο module να υλοποιεί πολλαπλές συμπεριφορές.

Για να δηλώσουμε ποια συνάρτηση προέρχεται από ποια συμπεριφορά, καλό είναι να χρησιμοποιούμε το χαρακτηριστικό module @impl πριν από κάθε συνάρτηση. Η τιμή του πρέπει να είναι το όνομα του module συμπεριφοράς που ορίζει αυτό το callback.

defmodule BookCollection do
  @behaviour Countable

  defstruct [:list, :owner]

  @impl Countable
  def count(collection) do
    Enum.count(collection.list)
  end

  def mark_as_read(collection, book) do
    # other function unrelated to the Countable behaviour
  end
end

Προεπιλεγμένες υλοποιήσεις callbacks

Όταν ορίζεις μια συμπεριφορά, είναι δυνατό να παρέχεις μια προεπιλεγμένη υλοποίηση ενός callback. Αυτή η υλοποίηση πρέπει να ορίζεται μέσα στην παρατιθέμενη έκφραση του macro __using__/1. Για να μπορούν όσοι χρησιμοποιούν το module συμπεριφοράς να παρακάμπτουν την προεπιλεγμένη υλοποίηση, κάλεσε το macro defoverridable/1 μετά την υλοποίηση της συνάρτησης. Δέχεται μια λίστα λέξεων-κλειδιών με ονόματα συναρτήσεων ως κλειδιά και πλήθη ορισμάτων συναρτήσεων ως τιμές.

defmodule Countable do
  @callback count(collection :: any) :: pos_integer

  defmacro __using__(_) do
    quote do
      @behaviour Countable
      def count(collection), do: Enum.count(collection)
      defoverridable count: 1
    end
  end
end

Σημείωσε ότι ο ορισμός συναρτήσεων μέσα στο __using__/1 δεν συνιστάται για οποιονδήποτε άλλο σκοπό εκτός από τον ορισμό προεπιλεγμένων υλοποιήσεων callbacks, αλλά μπορείς πάντα να ορίσεις συναρτήσεις σε ένα άλλο module και να τις εισάγεις με import στο macro __using__/1.