Turbo Ecto

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

Phoenix support turbo_html, check this repos.

Table of contents

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

Getting started

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

def deps do
  [
    {:turbo_ecto, "~> 0.1.7"}
  ]
end

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

config :turbo_ecto, Turbo.Ecto,
  repo: MyApp.Repo,
  per_page: 10

Examples

• Category Table Structure

  Field	Type	Comment
  name	string

• Product Table Structure

  Field	Type	Comment
  name	string
  body	text
  price	float
  category_id	integer
  available	boolean

• Variant Table Structure

  Field	Type	Comment
  name	string
  price	float
  product_id	integer

  iex> params = %{"q" => %{"product_category_name_and_product_name_or_name_like" => "elixir", "s" => "inserted_at+asc"}}

  iex> Turbo.Ecto.turboq(Turbo.Ecto.Variant, params)
  Ecto.Query<from v in subquery(from v in subquery(from v in subquery(from v in Turbo.Ecto.Variant),
    join: p in assoc(v, :product),
    join: c in assoc(p, :category),
    where: like(c.name, ^"%elixir%")),
    join: p in assoc(v, :product),
    where: like(p.name, ^"%elixir%")),
    or_where: like(v.name, ^"%elixir%"),
    limit: ^10, offset: ^0,
    order_by: [asc: v.inserted_at]>

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

Also supports:

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

More example pls move: docs

Search Matchers

List of all possible predicates

Credits

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