kingdomcoder

kingdomcoder

After a few (successful?) attempts at creating DSLs to get structured data from users, I realized that Elixir structs’ syntax fits perfectly what we’re looking for.

My idea is to allow users to type in text that’s valid Elixir for given structs (atom keys) and then read/parse that into internal data structures.

I’ve considered using Code.eval_string/3, a thin layer on Poison’s custom decoders, and building a parser combinator from scratch with NimbleParsec.

How would you suggest I proceed (and why, please)?

These are the factors I’m evaluating to choose what approach to take

  • The security of the approach
  • The time and effort required to implement the approach
  • The work required for future maintenance and extensibility

Any help is greatly appreciated.

Showing Posts 1 to 10

dimitarvp

dimitarvp

Give us an example what would your users type?

If it’s something as simple as name: "James", phone: 123 then you can get away with just using String and Enum.

D4no0

D4no0

Code.eval_string/3 is not safe, as you have full access to the runtime system, you can read the warning in the documentation.

kingdomcoder

kingdomcoder OP

My use case is more involved. I can have nested children up to 3 levels deep.

For example, this is possible:

%Parent{
    field: "Value",
    another_field: "Another value",
    child_list: [
        %Child{
            child_field: "Child 1 data",
            grandchildren_list: [%GrandChild{field: "Value"}, %GrandChild{field: "Some other value"}]
        },
        %Child{
            child_field: "Child 2 data"
        }
    ]
}
dimitarvp

dimitarvp

So your users basically type Elixir data structures?

hst337

hst337

Just use Code.string_to_quoted and traverse the AST. It is very easy to do

kingdomcoder

kingdomcoder OP

Exactly

kingdomcoder

kingdomcoder OP

I’ll try this and get back to you.

Thank you

kip

kip

ex_cldr Core Team

For the data you showed perhaps just consider JSON as the user-facing format? Non-evaling conversion to maps/structs without much work by you?

kingdomcoder

kingdomcoder OP

You’re right. The AST is easy to parse.

I might settle for this approach.

Thanks for pointing this out.

kingdomcoder

kingdomcoder OP

Thanks, @kip

JSON would have been my goto approach.

However, there are two nuances I have to consider:

  1. Any of Parent, Child, and GrandChild in the example above can be the root node, and the system’s behavior adjusts accordingly.

  2. GrandChild can be of multiple types and the keys for each are different (imagine TypeOne{some_key: "Value",...}, TypeTwo{another_key: "Value"...}…)

If I go with JSON, handling these nuances might mean tagging each sub(object) with {"type": "NodeNameHere", ...}.

For our largely non-technical user base, requiring this tag (along with requiring quotes around each JSON key) will be too verbose.

Atom-keyed Elixir structs feel more succinct and expressive.

# JSON
{
  "type": "Parent",
  "field": "Value",
  "another_field": "Another value",
  "child_list": [
      {
          "type": "Child"
          "child_field": "Child 1 data",
          "grandchildren_list": [
            {
              "type": "TypeOne",
              "field": "Value"
            },
            {
              "type": "TypeTwo",
              "another_field": "Some other value"
            }
        ]
      },
      {
          "type": "Child",
          "child_field": "Child 2 data"
      }
  ]
}

vs

# Struct
%Parent{
  field: "Value",
  another_field: "Another value",
  child_list: [
      %Child{
          child_field: "Child 1 data",
          grandchildren_list: [
            %TypeOne{field: "Value"},
            %TypeTwo{another_field: "Some other value"}
        ]
      },
      %Child{child_field: "Child 2 data"}
  ]
}

If there’s a workaround to reduce this verbosity, I’ll surely want to know 'cause parsing JSON will be an almost zero-stress approach for me.

Where Next? Top

Trending in Questions Top

stjefim
Hello! Suppose you are building workflow (order / task / payment) processing system with the following requirements: Each workflow con...
New
Blokh
Hey guys, I’ve got a huge CSV ( around 10 GB ) that needs to be processed hourly Do you guys have any suggestions what is the best prac...
New
kszambelanczyk
Hello! Could someone please give me a help/sample code, how to delete a file from s3 using waffle/waffle_ecto from Phoenix app. I creat...
New
Onor.io
I have what I’ve heard referred to as a “lookup table” in my database. This is a way of assigning codes to common values. One common lo...
New
jaybe78
Hello, I’m developing a online persistent chat system (what’s app) like using elixir/dynamodb/aws for a mobile app(flutter). The diffic...
New
Trolleger
What approach to take when sending live updates to “random” users Hi! I have a question, I have a little chat app, and when I create a DM...
New
widianto
I think I’ve found a small improvement I could contribute to <%= web_namespace %>.CoreComponents (installer/templates/phx_web/compo...
New

Other Trending Topics Top

garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New
aseigo
ICal is a library for interacting with iCalendar data. It parses iCalendars into typed Elixir structs via ICal.from_ics, and can prepare ...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews