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.

Where Next?

Popular in Questions Top

Kurisu
For example for a current url like http://localhost:4000/cosmetic/products?_utf8=✓&query=perfume&page=2, I would like to get: ...
New
shahryarjb
Hello, I get Persian date from my client and convert it to normal calendar like this: def jalali_string_to_miladi_english_number(persi...
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
dokuzbir
I want to highlight html closing tags when i click a html tag. That works in .html files but doesnt work for html.eex templates. How can...
New
JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New
nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

lastday4you
I wanted to check elixir version in phoenix because i found that my elixir is 1.5 but when i use Enum.chunk_by it said the function is un...
New
greenz1
I have a phoenix application from which a user can download multiple(5-6) files of size 1MB. I couldn’t find anything related to sending ...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
New
JeremM34
Hello, how can I check the Phoenix version ? Thanks !
New
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39297 209
New
AstonJ
We’ve put together this wiki for Phoenix LiveView - please feel free to add any info you feel is worth including. What is Phoenix LiveV...
New
klo
Got a question about when to concat vs. prepending items to list then reversing to achieve appending. So i know lists boil down to [1 | ...
New
hariharasudhan94
I would like to know what is the best IDE for elixir development?
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New

We're in Beta

About us Mission Statement