ecto_autoslug_field
is a reusable Ecto
library which can automatically create slugs from other fields.
This library internally uses slugger
as it's default slug-engine.
You can find the full documentation online: docs.
def deps do
# installation via hex (version 0.3 and onwards only supports `{:ecto, ">= 2.1"}`):
[{:ecto_autoslug_field, "~> 0.3"}]
# if you want to use github:
# [{:ecto_autoslug_field, github: "sobolevn/ecto_autoslug_field"}]
# if you need support for `{:ecto, "~> 2.0"}`:
# [{:ecto_autoslug_field, "~> 0.2"}]
# if you need support for older Ecto versions (< 2.0):
# [{:ecto_autoslug_field, "~> 0.1.3"}]
end
There are several options to configure.
Required:
:to
- represents the slug field name where toput_change
to
Optional:
:from
- represents the source fields from which to build slug, if this option is not set you have to overrideget_sources/2
function:always_change
- if this option is set slug will be recreated from the given sources each timemaybe_generate_slug
function is called
get_sources/2
- this function is used to get sources for the slug, docs.build_slug/2
- this function is a place to modify the result slug, docs.
The simplest example:
defmodule EctoSlugs.Blog.Article.TitleSlug do
use EctoAutoslugField.Slug, from: :title, to: :slug
end
defmodule EctoSlugs.Blog.Article do
use Ecto.Schema
import Ecto.Changeset
alias EctoSlugs.Blog.Article
alias EctoSlugs.Blog.Article.TitleSlug
schema "blog_articles" do
field :breaking, :boolean, default: false
field :content, :string
field :title, :string
field :slug, TitleSlug.Type
timestamps()
end
def changeset(%Article{} = article, attrs) do
article
|> cast(attrs, [:title, :content, :breaking])
|> validate_required([:title, :content])
|> unique_constraint(:title)
|> TitleSlug.maybe_generate_slug
|> TitleSlug.unique_constraint
end
end
More complex examples are covered in this tutorial.
See CHANGELOG.md.
MIT. Please see LICENSE.md for licensing details.