EctoAutoslugField
ecto_autoslug_field
is a reusable Ecto
library which can automatically create slugs from other fields.
This librabry internaly uses slugger
as a default slug-engine.
Installation
def deps do
# installation via hex:
[{:ecto_autoslug_field, "~> 0.1"}]
# if you want to use github:
# [{:ecto_autoslug_field, github: "sobolevn/ecto_autoslug_field"}]
end
Examples
The simplest example:
defmodule NameSlug do
use EctoAutoslugField.Slug, from: :name, to: :slug
end
defmodule User do
use Ecto.Schema
import Ecto.Changeset
schema "users" do
field :name, :string
field :slug, NameSlug.Type
end
@required_fields ~w(name)
@optional_fields ~w(slug)
def changeset(model, params \\ :empty) do
model
|> cast(params, @required_fields, @optional_fields)
|> NameSlug.maybe_generate_slug
|> NameSlug.unique_constraint
end
end
More complex example:
defmodule ComplexSlug do
use EctoAutoslugField.Slug, to: :slug
def get_sourses(changeset, _opts) do
# This function is used to get sources to build slug from:
base_fields = [:title]
if get_change(changeset, :breaking, false) do
base_fields ++ ["breaking"]
else
base_fields
end
end
def build_slug(sources) do
# Custom slug building rule:
sources
|> Enum.join("-")
|> Slugger.slugify_downcase
|> String.replace("-", "+")
end
end
defmodule Article do
use Ecto.Schema
import Ecto.Changeset
schema "articles" do
field :title, :string
field :breaking, :boolean
field :slug, ComplexSlug.Type
end
@required_fields ~w(title breaking)
@optional_fields ~w(slug)
def changeset(model, params \\ :empty) do
model
|> cast(params, @required_fields, @optional_fields)
|> ComplexSlug.maybe_generate_slug
|> ComplexSlug.unique_constraint
end
end
Changelog
See CHANGELOG.md.
License
MIT. Please see LICENSE.md for licensing details.