Trubo Ecto

Trubo is a very rich ecto component,including search sort and paginate. Inspiration by ruby ransack and learn from rummage_ecto

Table of contents

• Getting started
• Examples
• Search Matchers
• Features
• Credits

Getting started

• The package can be installed by adding trubo_ecto to your list of dependencies in mix.exs:

def deps do
  [
    {:trubo_ecto, "~> 0.1.0"}
  ]
end

• Add the Repo of your app and the desired per_page to the trubo_ecto configuration in config.exs:

config :trubo_ecto, Trubo.Ecto,
  repo: MyApp.Repo,
  per_page: 10

• Or add the trubo_ecto with elixir use

use Ttrubo.Ecto, repo: MyApp.Repo, per_page: 10

Examples

iex> params = %{
  "q" => %{"title_like" => "hello123", "category_id_eq" => 1},
  "s" => "inserted_at+asc",
  "per_page" => 5, "page" => 10
}

iex> Trubo.Ecto.truboq(Product, params)
#Ecto.Query<from t in Product, where: t.type == ^1,
  where: like(t.title, ^"%hello123%"),
  order_by: [asc: t.inserted_at],
  limit: ^5, offset: ^45>

iex> Trubo.Ecto.trubo(Product, params)
%{
  datas: [Product.t()],
  paginate: %{
    current_page: 10,
    next_page: 11,
    per_page: 5,
    prev_page: 9,
    total_count: 100,
    total_pages: 20
  }
}

Also supports:

• Use Trubo.Ecto.search only returns search result or use Trubo.Ecto.searchq returns search queryable;
• Use Trubo.Ecto.sort only returns sort result or use Trubo.Ecto.sortq returns sort queryable;
• Use Trubo.Ecto.paginate returns pagiante result or use Trubo.Ecto.paginateq returns paginate queryable.

More example pls move: docs

Search Matchers

List of all possible predicates

Features

• Example website.
• Add the necessary code test.
• Support and and or symbol e.g. q[title_or_body_like]=hello123
• Support multi table assoc search.
• Support multi table assoc sort.

Credits

• ecto - Very great API.
• ransack - Initial inspiration of this project.
• rummage_ecto - Similar implementation.