acrolink

acrolink

I am using something like this to filter Ecto.Query results:

  def build_query(query, "order_by", order_by, _conn) when order_by != "" do
    case order_by do
      "desc_inserted_at" -> Ecto.Query.order_by(query, [p], [desc: p.inserted_at])
      "asc_inserted_at" -> Ecto.Query.order_by(query, [p], [asc: p.inserted_at])
      "desc_title" -> Ecto.Query.order_by(query, [p], [desc: p.title])
      "asc_title" -> Ecto.Query.order_by(query, [p], [asc: p.title])
      _ -> query
    end
  end

I will be passing to this method order_by variables with values like name, id, inserted_at, etc preceded by either desc or asc, e.g. desc_inserted_at.

My question, how to make it in less repetitive code, especially when it comes to specifying the direction desc or asc ? Thank you.

First 10 of 20 Posts Switch mode

kokolegorille

kokolegorille

It would be easier to have a dir and order…

eg.

[h, t] = order_by |> String.split("_")
dir = h |> String.to_atom
order = t |> Enum.join("_") |> String.to_atom
Ecto.Query.order_by(query, [p], Keyword.put([], dir, Keyword.get(p, order)))

That does not check input validity, but You might see what I mean. It is not tested…

BTW You can use Regex like this to get metadata

iex> Regex.named_captures ~r/(?<dir>asc|desc)_(?<order>.*)/, "desc_inserted_at"
%{"dir" => "desc", "order" => "inserted_at"}

UPDATE: I have should have written [h | t], thanks @blatyo for spotting typo

blatyo

blatyo

Conduit Core Team

I tend to use pattern matching in function heads. Here’s how I might approach it.

@order_by_fields ["inserted_at", "title"]
def build_query(query, "order_by", "", _conn), do: query
def build_query(query, "order_by", "desc_" <> field, _conn) when field in @order_by_fields do
  Ecto.Query.order_by(query, [p], [desc: String.to_atom(field)])
end
def build_query(query, "order_by", "asc_" <> field, _conn) when field in @order_by_fields do
  Ecto.Query.order_by(query, [p], [asc: String.to_atom(field)])
end
blatyo

blatyo

Conduit Core Team

Looks like you meant [h | t] = order_by |> String.split("_")

kokolegorille

kokolegorille

Oh Yes, my bad :slight_smile:

McElaney

McElaney

Just add a step to the transformation that handles the repetitive bits. Easier to read than trying to meta program your way in to it.

  def build_query(query, "order_by", order_by, _conn) when order_by != "" do
    order_by
    |> case do
         "desc_inserted_at" -> [desc: p.inserted_at]
         "asc_inserted_at" -> [asc: p.inserted_at]
         "desc_title" -> [desc: p.title]
         "asc_title" -> [asc: p.title]
         _ ->[]
       end
    |> build_query_order
  end

  defp build_query_order([]), do: query
  defp build_query_order(params), Ecto.Query.order_by(query, [p], params)
idi527

idi527

  def build_query(query, "order_by", order_by, _conn) when order_by != "" do
    order_by = case order_by do
      "desc_" <> field -> [desc: String.to_existing_atom(field)]
      "asc_" <> field -> [asc: String.to_existing_atom(field)]
      _other -> [] # will be ignored by the ecto query builder (the final sql statement won't have an ORDER BY)
    end
    Ecto.Query.order_by(query, order_by)
  end

I wouldn’t pass strings to a “context”, though. I would parse these strings at the boundary and turn them into more manageable data structures like {:order_by, :desc, :inserted_at}, which would be easier to handle inside the “context”.

On the boundary (maybe a controller):

valid_order_bys = [
  {"desc_inserted_at", {:desc, :inserted_at}}, # these can be automatically generated as well
  # etc ...
]

Enum.map(valid_order_bys, fn {valid_order_by_string, valid_order_by_tuple} ->
  defp parse_order_by(unquote(valid_order_by_string)), do: unquote(valid_order_by_tuple)
end)
defp parse_order_by(invalid_order_by_string) do
  # raise or log an error
end

# other parse_search_options clauses
defp parse_search_options([{"order_by", order_by} | rest], acc) do # I suspect it's for a search, but you can name it whatever you want
  parse_search_options(rest, [{:order_by, parse_order_by(order_by)} | acc])
end
# other parse_search_options clauses

Then in the “context”

# other build_query clauses
defp build_query([{:order_by, {direction, field} = opts} | rest], acc_query) do
  build_query(rest, Ecto.Query.order_by(acc_query, [opts]))
end
# other build_query clauses
acrolink

acrolink OP

Thank you all for all possible solutions provided, I simply love Elixir. Much can be done with little code. I suspect other languages like JAVA won’t allow similar shortcuts, power and flexibility.

jordiee

jordiee

I may be wrong here but is it not slightly dangerous to use String.to_atom on what I suspect is user passed strings. This opens up an attack vector for memory issues because atoms are not garbage collected. Again correct me if I am wrong.

idi527

idi527

Yeah, it is dangerous. String.to_existing_atom/1 can be used instead.

kokolegorille

kokolegorille

Yes… You need to validate input in my code to avoid bad surprise :slight_smile:

I like @blatyo pattern matching solution, as it includes sanity check, but the main point is to separate order_by in direction/order, so that You need only one Ecto.Query command.

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
jonnycharles
I’m in search of an Elixir library that offers PDF generation capabilities similar to Ruby’s Prawn. While there have been discussions abo...
New
spammy
I’m looking to build a personal workflow to quickly deploy web applications written in elixir/phoenix, for local consumption (ie not on t...
New
silverdr
Using Phoenix.LiveView.TagEngine as an EEx.Engine is deprecated! To compile HEEx, use Phoenix.LiveView.TagEngine.compile/2 instead. Sta...
New
dli
Before I dive in myself, did anyone successfully sprinkle Hologram into their existing LiveView app? Looking for hints regarding: Addi...
New
bottlenecked
Hi all, I wanted to ask how the community is dealing with post-release steps. Today we have Ecto migrations, which make sure that the db...
New
roeland
Kia ora, We have been using elixir-google-api to connect to Google Drive. However, with the updates to Tesla due to CVEs this is now bro...
New

Other Trending Topics Top

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
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New

We're in Beta

About us Mission Statement