Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wemake-services/ecto_autoslug_field
Automatically create slugs for Ecto schemas.
https://github.com/wemake-services/ecto_autoslug_field
ecto ecto-extension ecto-types elixir elixir-lang elixir-library slugs
Last synced: about 7 hours ago
JSON representation
Automatically create slugs for Ecto schemas.
- Host: GitHub
- URL: https://github.com/wemake-services/ecto_autoslug_field
- Owner: wemake-services
- License: mit
- Created: 2016-07-20T20:49:48.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T08:53:58.000Z (7 months ago)
- Last Synced: 2024-04-14T07:11:38.819Z (7 months ago)
- Topics: ecto, ecto-extension, ecto-types, elixir, elixir-lang, elixir-library, slugs
- Language: Elixir
- Homepage: https://hexdocs.pm/ecto_autoslug_field
- Size: 271 KB
- Stars: 147
- Watchers: 6
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Automatically creates slugs for your Ecto models. (Miscellaneous)
README
# EctoAutoslugField
[](https://github.com/sobolevn/ecto_autoslug_field/actions?query=workflow%3Atest)
[](https://coveralls.io/github/sobolevn/ecto_autoslug_field?branch=master)
[](https://hex.pm/packages/ecto_autoslug_field)
[](https://hexdocs.pm/ecto_autoslug_field/)
[](https://github.com/sobolevn/ecto_autoslug_field/blob/master/LICENSE)
`ecto_autoslug_field` is a reusable [`Ecto`](https://github.com/elixir-ecto/ecto) library which can automatically create slugs from other fields. We use [`slugify`](https://github.com/jayjun/slugify) as a default slug-engine.
We only depend on the `ecto` package (we do not deal with `ecto_sql` at all).
We support `ecto >= 3.7 and ecto < 4`!
See [this blog post](https://sobolevn.me/2017/07/creating-slugs-for-ecto-schemas)
for more information.
## Installation
```elixir
def deps do
[
{:ecto_autoslug_field, "~> 3.1"}
]
end
```
## Options
There are several options to configure.
Required:
- `:to` - represents the slug field name where to save value to
Optional:
- `:from` - represents the source fields from which to build slug, if this option is not set you have to override `get_sources/2` function
- `:always_change` - if this option is set slug will be recreated from the given sources each time `maybe_generate_slug` function is called
## Functions
- `get_sources/2` - this function is used to get sources for the slug, [docs](https://hexdocs.pm/ecto_autoslug_field/EctoAutoslugField.SlugBase.html#get_sources/2).
- `build_slug/2` - this function is a place to modify the result slug, [docs](https://hexdocs.pm/ecto_autoslug_field/EctoAutoslugField.SlugBase.html#build_slug/2).
## Examples
The simplest example:
```elixir
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(model, params \\ :invalid) do
model
|> cast(params, [:title, :content, :breaking])
|> validate_required([:title, :content])
|> unique_constraint(:title)
|> TitleSlug.maybe_generate_slug()
|> TitleSlug.unique_constraint()
end
end
```
See [this tutorial](https://sobolevn.me/2017/07/creating-slugs-for-ecto-schemas)
for some more examples.
## Changelog
See [CHANGELOG.md](./CHANGELOG.md).
## Copyright and License
Copyright (c) 2016 Nikita Sobolev
This library is released under the MIT License. See the [LICENSE.md](./LICENSE.md) file
for further details.