defmodule Plasm do import Ecto.Query @doc """ Builds a query that finds all records at a specified date and time for a specified field name. Puppy |> Plasm.at(:updated_at, date_time) |> Repo.all Puppy |> Plasm.at(:updated_at, "2014-04-17T14:00:00Z") |> Repo.all """ @spec at(Ecto.Queryable.t(), atom, %DateTime{}) :: Ecto.Queryable.t() def at(query, field_name, %DateTime{} = date_time) when is_atom(field_name) do query |> where([x], field(x, ^field_name) == ^date_time) end @spec at(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def at(query, field_name, castable) when is_atom(field_name) do date_time = cast_to_date_time!(castable) query |> at(field_name, date_time) end @doc """ Builds a query that finds all records at or before a specified date and time for a specified field name. Puppy |> Plasm.at_or_earlier_than(:updated_at, date_time) |> Repo.all Puppy |> Plasm.at_or_earlier_than(:updated_at, "2014-04-17") |> Repo.all """ @spec at_or_earlier_than(Ecto.Queryable.t(), atom, %DateTime{}) :: Ecto.Queryable.t() def at_or_earlier_than(query, field_name, %DateTime{} = date_time) when is_atom(field_name) do query |> where([x], field(x, ^field_name) <= ^date_time) end @spec at_or_earlier_than(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def at_or_earlier_than(query, field_name, castable) when is_atom(field_name) do date_time = cast_to_date_time!(castable) query |> at_or_earlier_than(field_name, date_time) end @doc """ Builds a query that finds all records at a specified date and time for a specified field name. Puppy |> Plasm.at_or_later_than(:updated_at, date_time) |> Repo.all Puppy |> Plasm.at_or_later_than(:updated_at, "2014-04-17") |> Repo.all """ @spec at_or_later_than(Ecto.Queryable.t(), atom, %DateTime{}) :: Ecto.Queryable.t() def at_or_later_than(query, field_name, %DateTime{} = date_time) when is_atom(field_name) do query |> where([x], field(x, ^field_name) >= ^date_time) end @spec at_or_later_than(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def at_or_later_than(query, field_name, castable) when is_atom(field_name) do date_time = cast_to_date_time!(castable) query |> at_or_later_than(field_name, date_time) end @doc """ Builds an average query for a given field. Puppy |> Plasm.average(:age) |> Repo.one Puppy |> Plasm.average("age") |> Repo.one """ @spec average(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def average(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> average(field_name) end @spec average(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def average(query, field_name) when is_atom(field_name) do query |> select([x], avg(field(x, ^field_name))) end @doc """ Builds a count query. Puppy |> Plasm.count |> Repo.one """ @spec count(Ecto.Queryable.t()) :: Ecto.Queryable.t() def count(query) do query |> select([x], count(x.id)) end @doc """ Builds a distinct count query for a given field. Puppy |> Plasm.count_distinct(:name) |> Repo.one Puppy |> Plasm.count_distinct("age") |> Repo.one """ @spec count_distinct(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def count_distinct(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> count_distinct(field_name) end @spec count_distinct(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def count_distinct(query, field_name) when is_atom(field_name) do query |> select([x], count(field(x, ^field_name), :distinct)) end @doc """ Builds a distinct query for a given field. Puppy |> Plasm.distinct_by(:age) |> Repo.all Puppy |> Plasm.distinct_by("name") |> Repo.all """ @spec distinct_by(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def distinct_by(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> distinct_by(field_name) end @spec distinct_by(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def distinct_by(query, field_name) when is_atom(field_name) do query |> distinct([x], field(x, ^field_name)) end @doc """ Builds a query that finds all records before a specified date or date and time for a specified field name. Puppy |> Plasm.earlier_than(:updated_at, date_or_date_time) |> Repo.all Puppy |> Plasm.earlier_than(:updated_at, "2014-04-17") |> Repo.all """ @spec earlier_than(Ecto.Queryable.t(), atom, %Date{}) :: Ecto.Queryable.t() def earlier_than(query, field_name, %Date{} = date) when is_atom(field_name) do query |> where([x], fragment("?::date", field(x, ^field_name)) < ^date) end @spec earlier_than(Ecto.Queryable.t(), atom, %DateTime{}) :: Ecto.Queryable.t() def earlier_than(query, field_name, %DateTime{} = date_time) when is_atom(field_name) do date = DateTime.to_date(date_time) query |> earlier_than(field_name, date) end @spec earlier_than(Ecto.Queryable.t(), atom, String.t | number) :: Ecto.Queryable.t() def earlier_than(query, field_name, castable) when is_atom(field_name) and is_binary(castable) or is_number(castable) do date_or_date_time = case cast_to_date_time(castable) do {:ok, date_time} -> date_time :error -> cast_to_date!(castable) end query |> earlier_than(field_name, date_or_date_time) end @doc """ Builds a query that finds all records matching any of the primary key values in the provided list or value. Puppy |> Plasm.find([1,2,3]) |> Repo.all Puppy |> Plasm.find(10) |> Repo.one Puppy |> Plasm.find("748192739812839") |> Repo.one """ @spec find(Ecto.Queryable.t(), list) :: Ecto.Queryable.t() def find(query, primary_key_values) when is_list(primary_key_values) do key = primary_key(query) query |> where_all([{key, primary_key_values}]) end @spec find(Ecto.Queryable.t(), any) :: Ecto.Queryable.t() def find(query, primary_key_value) do key = primary_key(query) query |> where_all([{key, primary_key_value}]) end @doc """ Builds a query that finds the first record after sorting by a specified field name ascending. Optionally, provide an integer `n` to find only the first `n` records. Puppy |> Plasm.earliest(:inserted_at) |> Repo.one Puppy |> Plasm.earliest(:inserted_at, 20) |> Repo.all """ @spec earliest(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def earliest(query, field_name) when is_atom(field_name) do query |> earliest(field_name, 1) end @spec earliest(Ecto.Queryable.t(), atom, integer) :: Ecto.Queryable.t() def earliest(query, field_name, n) when is_atom(field_name) and is_integer(n) do query |> order_by(asc: ^field_name) |> limit(^n) end @doc """ Builds a query that finds all records after a specified field name and date or date and time. Puppy |> Plasm.later_than(date) |> Repo.all Puppy |> Plasm.later_than("2014-04-17") |> Repo.all """ @spec later_than(Ecto.Queryable.t(), atom, %Date{}) :: Ecto.Queryable.t() def later_than(query, field_name, %Date{} = date) when is_atom(field_name) do query |> where([x], fragment("?::date", field(x, ^field_name)) > ^date) end @spec later_than(Ecto.Queryable.t(), atom, %DateTime{}) :: Ecto.Queryable.t() def later_than(query, field_name, %DateTime{} = date_time) when is_atom(field_name) do date = DateTime.to_date(date_time) query |> later_than(field_name, date) end @spec later_than(Ecto.Queryable.t(), atom, String.t | number) :: Ecto.Queryable.t() def later_than(query, field_name, castable) when is_atom(field_name) and is_binary(castable) or is_number(castable) do value = case cast_to_date_time(castable) do {:ok, date_time} -> date_time :error -> cast_to_date!(castable) end query |> later_than(field_name, value) end @doc """ Builds a query that finds the last record after sorting by a specified field name ascending. Optionally, provide an integer `n` to find only the last `n` records. Puppy |> Plasm.latest(:inserted_at) |> Repo.one Puppy |> Plasm.latest(:inserted_at, 20) |> Repo.all """ @spec latest(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def latest(query, field_name) when is_atom(field_name) do query |> latest(field_name, 1) end @spec latest(Ecto.Queryable.t(), atom, integer) :: Ecto.Queryable.t() def latest(query, field_name, n) when is_atom(field_name) and is_integer(n) do query |> order_by(desc: ^field_name) |> limit(^n) end @doc """ Builds a maximum query for a given field. Puppy |> Plasm.maximum(:age) |> Repo.one Puppy |> Plasm.maximum("age") |> Repo.one """ @spec maximum(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def maximum(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> maximum(field_name) end @spec maximum(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def maximum(query, field_name) when is_atom(field_name) do query |> select([x], max(field(x, ^field_name))) end @doc """ Builds a minimum query for a given field. Puppy |> Plasm.minimum(:age) |> Repo.one Puppy |> Plasm.minimum("age") |> Repo.one """ @spec minimum(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def minimum(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> minimum(field_name) end @spec minimum(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def minimum(query, field_name) when is_atom(field_name) do query |> select([x], min(field(x, ^field_name))) end @doc """ Builds a query that finds all records on a specified date for a specified field name. Puppy |> Plasm.on(:inserted_at, date) |> Repo.all Puppy |> Plasm.on(:inserted_at, "2014-04-17") |> Repo.all """ @spec on(Ecto.Queryable.t(), atom, %Date{}) :: Ecto.Queryable.t() def on(query, field_name, %Date{} = date) when is_atom(field_name) do query |> where([x], fragment("?::date", field(x, ^field_name)) == ^date) end @spec on(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def on(query, field_name, castable) when is_atom(field_name) do date = cast_to_date!(castable) query |> on(field_name, date) end @doc """ Builds a query that finds all records on or before a specified date for a specified field name. Puppy |> Plasm.on_or_earlier_than(date) |> Repo.all Puppy |> Plasm.on_or_earlier_than("2014-04-17") |> Repo.all """ @spec on_or_earlier_than(Ecto.Queryable.t(), atom, %Date{}) :: Ecto.Queryable.t() def on_or_earlier_than(query, field_name, %Date{} = date) when is_atom(field_name) do {:ok, next_day_date} = date |> Date.to_erl |> :calendar.date_to_gregorian_days |> Kernel.+(1) |> :calendar.gregorian_days_to_date |> Date.from_erl query |> where([x], fragment("?::date", field(x, ^field_name)) < ^next_day_date) end @spec on_or_earlier_than(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def on_or_earlier_than(query, field_name, castable) when is_atom(field_name) do date = cast_to_date!(castable) query |> on_or_earlier_than(field_name, date) end @doc """ Builds a query that finds all records on or after a specified date for a specified field name. Puppy |> Plasm.on_or_later_than(date) |> Repo.all Puppy |> Plasm.on_or_later_than("2014-04-17") |> Repo.all """ @spec on_or_later_than(Ecto.Queryable.t(), atom, %Date{}) :: Ecto.Queryable.t() def on_or_later_than(query, field_name, %Date{} = date) when is_atom(field_name) do query |> where([x], fragment("?::date", field(x, ^field_name)) >= ^date) end @spec on_or_later_than(Ecto.Queryable.t(), atom, any) :: Ecto.Queryable.t() def on_or_later_than(query, field_name, castable) when is_atom(field_name) do date = cast_to_date!(castable) query |> on_or_later_than(field_name, date) end @doc """ Builds a query that grabs a random record. Optionally, provide an integer `n` to fetch `n` random records. Puppy |> Plasm.random |> Repo.one Puppy |> Plasm.random(20) |> Repo.all """ @spec random(Ecto.Queryable.t()) :: Ecto.Queryable.t() def random(query) do query |> random(1) end @spec random(Ecto.Queryable.t(), integer) :: Ecto.Queryable.t() def random(query, n) when is_integer(n) do # TODO: support databases other than postgres query |> order_by([_], fragment("RANDOM()")) |> limit(^n) end @doc """ Builds a sum query for a given field. Puppy |> Plasm.total(:age) |> Repo.one Puppy |> Plasm.total("age") |> Repo.one """ @spec total(Ecto.Queryable.t(), String.t) :: Ecto.Queryable.t() def total(query, field_name) when is_binary(field_name) do field_name = String.to_atom(field_name) query |> total(field_name) end @spec total(Ecto.Queryable.t(), atom) :: Ecto.Queryable.t() def total(query, field_name) when is_atom(field_name) do query |> select([x], sum(field(x, ^field_name))) end @doc """ Builds a query that finds all records matching all specified field names and values. Values can be lists or non-lists. When the values are all non-lists, it simply delegates to `Ecto.Query.where`. When there is at least one list value, it builds the query itself, using `in` for lists. Puppy |> Plasm.where_all(name: "Fluffy", age: 3) |> Repo.all Puppy |> Plasm.where_all(name: "Fluffy", age: [3,5,10]) |> Repo.all """ @spec where_all(Ecto.Queryable.t(), list) :: Ecto.Queryable.t() def where_all(query, field_names_and_values) do contains_at_least_one_list = Keyword.values(field_names_and_values) |> Enum.any?(fn (value) -> is_list(value) end) query |> do_where_all(field_names_and_values, contains_at_least_one_list) end @doc """ Builds a query that finds all records matching none of the specified field names and values. Values can be lists or non-lists. Non-list expressions result in a `!=` comparison. List expressions result in a `not in` comparison. Puppy |> Plasm.where_none(name: "Fluffy", age: 3) |> Repo.all Puppy |> Plasm.where_none(name: "Fluffy", age: [3,5,10]) |> Repo.all """ @spec where_none(Ecto.Queryable.t(), list) :: Ecto.Queryable.t() def where_none(query, field_names_and_values) do Enum.reduce(field_names_and_values, query, fn ({field_name, field_value}, query) -> generate_where_clause_for_where_none(query, field_name, field_value) end) end # PRIVATE ################################################## defp primary_key(query) do [key] = model(query).__schema__(:primary_key) key end defp model(%Ecto.Query{from: {_table_name, model_or_query}}) do model(model_or_query) end defp model(model), do: model defp generate_where_clause_for_where_all(query, field_name, field_value) when is_list(field_value) do query |> where([x], field(x, ^field_name) in ^field_value) end defp generate_where_clause_for_where_all(query, field_name, field_value) do query |> where([x], field(x, ^field_name) == ^field_value) end defp generate_where_clause_for_where_none(query, field_name, field_value) when is_list(field_value) do query |> where([x], field(x, ^field_name) not in ^field_value) end defp generate_where_clause_for_where_none(query, field_name, field_value) do query |> where([x], field(x, ^field_name) != ^field_value) end defp do_where_all(query, field_names_and_values, true) do Enum.reduce(field_names_and_values, query, fn ({field_name, field_value}, query) -> generate_where_clause_for_where_all(query, field_name, field_value) end) end defp do_where_all(query, field_names_and_values, false) do query |> where(^field_names_and_values) end defp cast_to_date_time(castable) when is_binary(castable) do case DateTime.from_iso8601(castable) do {:ok, date_time, _} -> {:ok, date_time} {:error, _} -> :error end end defp cast_to_date_time(castable) when is_number(castable) do case DateTime.from_unix(castable) do {:ok, date_time} -> {:ok, date_time} {:error, _} -> :error end end defp cast_to_date_time!(castable) when is_binary(castable) do case DateTime.from_iso8601(castable) do {:ok, date_time, _} -> date_time {:error, _} -> raise ArgumentError, message: "invalid argument when casting to DateTime: #{inspect(castable)}" end end defp cast_to_date_time!(castable) when is_number(castable) do case DateTime.from_unix(castable) do {:ok, date_time} -> date_time {:error, _} -> raise ArgumentError, message: "invalid argument when casting to DateTime: #{inspect(castable)}" end end defp cast_to_date!(castable) do case Date.from_iso8601(castable) do {:ok, date} -> date {:error, _} -> raise ArgumentError, message: "invalid argument when casting to Date: #{inspect(castable)}" end end end