akin

akin

Need help understanding the Spark library

Questions abut Spark

I am working on an Elixir library that provides a Domain-Specific Language (DSL). I plan to use the Spark library and have a few questions regarding its implementation in a project. My questions are as follows:

  1. With Spark, how do you implement the actual functionality of your DSL? Specifically, once you have defined your sections and entities, how do you define the code that will be quoted by each section and entity?
  2. Am I correct in assuming that the sections and entities are macros that quote code, or is there something fundamental about Spark’s operation that I’m missing?
  3. My library focuses more on using a single macro with numerous options rather than nesting multiple macros. I’m primarily interested in Spark for its tooling capabilities. Given this context, do you think Spark would be a good fit for my library?

Any help is welcome.

Most Liked

zachdaniel

zachdaniel

Creator of Ash

Hello! So spark is primarily designed for helping to build “structural” DSLs. I.e defining data.

For example, in Ash Framework, on an Ash.Resource

attributes do
  attribute :name, :string, allow_nil?: false
end

That is a section called :attributes, with an entity called :attribute. We then extract this using:

Ash.Resource.Info.attributes(module, :attributes)

which gives us, for example:

%Attribute{
  name: :name,
  type: :string,
  allow_nil?: false
}

(the examples are greatly simplified from real life).

So the DSL simply holds the description. It’s just “something else” (whatever else you want) that contains the “actual functionality” of the DSL. You can leverage it at compile time to do code generation, or at runtime to interpret the data structure however you like.

If you want things to happen “in the module”, then you can use transformers, i.e

defmodule YourTransformer do
  use Spark.Dsl.Transformer

  def transform(dsl_state) do
    {:ok, 
      Spark.Dsl.Transformer.eval(dsl_state, [], quote do
         ...your quoted code here
      end)
    }
  end
end

If you’re looking to write something like a single macro that contains some kind of customized imperative/declarative/expression language, then spark is unlikely to help you.

i.e if you’re looking to make something like NX or something like Ecto’s Ecto.Query macros.

Last Post!

akin

akin

Thank you very much for respond to my questions. Yes, I want to write something like single macro with multiple declarative configurations, so I’ll be looking into other solutions beyond Spark.

Where Next?

Trending in Questions Top

lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New
senggen
Erlang/OTP 25 [erts-13.2.2] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] 15:22:35.803 [error] gen_event {lager_file_backend...
New
hariharasudhan94
Lets say I have map like this fetching from my database %{"_id" => #BSON.ObjectId<58eb1a7a9ad169198c3dXXXX>, "email" => ...
New
tj0
I’ve been following the steps here for the upgrade from 1.6 to 1.7 and it has gone relatively smoothly all the way till the phoenix_view ...
New
cgraham
Hi! What is currently the best library/method for parsing text and tabular data out of PDF files in Elixir or Erlang?
New
stefanchrobot
Hi, I need a way to handle data migrations in my application. I found an article by @wojtekmach about manual migrations: Automatic and ma...
New
stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New

Other Trending Topics Top

GenericJam
Edit: 2026 May 15 - This post is archived. Mob is alive!! Main docs: mob v0.7.11 — Documentation A bit of explanation for the slightly c...
New
JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
kip
Localize is the next generation localisation library for Elixir. Think of it as ex_cldr version 3.0. The first version will be released ...
New
webofbits
Squid Mesh is an open source workflow automation runtime for Elixir applications. It is aimed at Phoenix and OTP apps that want to defin...
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
kip
In 2021 I started a new library called Tempo with the objective of modelling time as a set of intervals - not as instants. In 2022 I gave...
New

We're in Beta

About us Mission Statement