Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asiniy/ecto_state_machine
State machine pattern for Ecto
https://github.com/asiniy/ecto_state_machine
ecto ecto-state-machine elixir elixir-lang
Last synced: 9 days ago
JSON representation
State machine pattern for Ecto
- Host: GitHub
- URL: https://github.com/asiniy/ecto_state_machine
- Owner: asiniy
- Created: 2016-05-11T04:16:54.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-03T15:47:44.000Z (almost 5 years ago)
- Last Synced: 2024-11-11T05:54:15.752Z (about 1 month ago)
- Topics: ecto, ecto-state-machine, elixir, elixir-lang
- Language: Elixir
- Size: 31.3 KB
- Stars: 97
- Watchers: 5
- Forks: 20
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Finite state machine pattern implemented on Elixir and adopted for Ecto. (Algorithms and Data structures)
- fucking-awesome-elixir - ecto_state_machine - Finite state machine pattern implemented on Elixir and adopted for Ecto. (Algorithms and Data structures)
- awesome-elixir - ecto_state_machine - Finite state machine pattern implemented on Elixir and adopted for Ecto. (Algorithms and Data structures)
README
# Ecto state machine
This package allows to use [finite state machine pattern](https://en.wikipedia.org/wiki/Finite-state_machine) in Ecto. Specify:
* states
* events
* column ([optional](#custom-column-name))
and go:
``` elixir
defmodule User do
use Web, :model
use EctoStateMachine,
states: [:unconfirmed, :confirmed, :blocked, :admin],
events: [
[
name: :confirm,
from: [:unconfirmed],
to: :confirmed,
callback: fn(model) -> Ecto.Changeset.change(model, confirmed_at: Ecto.DateTime.utc) end # yeah you can bring your own code to these functions.
], [
name: :block,
from: [:confirmed, :admin],
to: :blocked
], [
name: :make_admin,
from: [:confirmed],
to: :admin
]
]
schema "users" do
field :state, :string, default: "unconfirmed"
end
end
```
now you can do:
``` elixir
user = Repo.get_by(User, id: 1)
# Create changeset transition user state to "confirmed". We can make him admin!
confirmed_user = User.confirm(user) # =>
# We can validate ability to change user's state
User.can_confirm?(confirmed_user) # => false
User.can_make_admin?(confirmed_user) # => true
# Create changeset transition user state to "admin"
admin = User.make_admin(confirmed_user)
# Store changeset to the database
Repo.update(admin)
# List all possible states
# If column isn't `:state`, function name will be prefixed. IE,
# for column `:rules` function name will be `rules_states`
User.states # => [:unconfirmed, :confirmed, :blocked, :admin]
# List all possible events
# If column isn't `:state`, function name will be prefixed. IE,
# for column `:rules` function name will be `rules_events`
User.events # => [:confirm, :block, :make_admin]
```
You can check out whole `test/dummy` directory to inspect how to organize sample app.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add ecto_state_machine to your list of dependencies in `mix.exs`:
def deps do
[{:ecto_state_machine, "~> 0.1.0"}]
end
### Custom column name
`ecto_state_machine` uses `state` database column by default. You can specify
`column` option to change it. Like this:
``` elixir
defmodule Dummy.User do
use Dummy.Web, :model
use EctoStateMachine,
column: :rules,
# bla-bla-bla
end
```
Now your state will be stored into `rules` column.
## Contributions
1. Install dependencies `mix deps.get`
1. Setup your `config/test.exs` & `config/dev.exs`
1. Run migrations `mix ecto.migrate` & `MIX_ENV=test mix ecto.migrate`
1. Develop new feature
1. Write new tests
1. Test it: `mix test`
1. Open new PR!
## Roadmap to 1.0
- [x] Cover by tests
- [x] Custom db column name
- [x] Validation method for changeset indicates its value in the correct range
- [x] Initial value
- [x] CI
- [x] Add status? methods
- [ ] Introduce it at elixir-radar and my blog
- [ ] Custom error messages for changeset (with translations by gettext ability)
- [x] Rely on last versions of ecto & elixir
- [ ] Write dedicated module instead of requiring everything into the model
- [ ] Write bang! methods which are raising exception instead of returning invalid changeset
- [ ] Rewrite spaghetti description in README