{"id":13507206,"url":"https://github.com/asiniy/ecto_state_machine","last_synced_at":"2025-04-06T22:08:37.247Z","repository":{"id":57493666,"uuid":"58513820","full_name":"asiniy/ecto_state_machine","owner":"asiniy","description":"State machine pattern for Ecto","archived":false,"fork":false,"pushed_at":"2020-03-03T15:47:44.000Z","size":32,"stargazers_count":99,"open_issues_count":15,"forks_count":20,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-30T20:12:44.273Z","etag":null,"topics":["ecto","ecto-state-machine","elixir","elixir-lang"],"latest_commit_sha":null,"homepage":null,"language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asiniy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-05-11T04:16:54.000Z","updated_at":"2025-01-29T13:08:17.000Z","dependencies_parsed_at":"2022-08-30T04:00:52.518Z","dependency_job_id":null,"html_url":"https://github.com/asiniy/ecto_state_machine","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiniy%2Fecto_state_machine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiniy%2Fecto_state_machine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiniy%2Fecto_state_machine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asiniy%2Fecto_state_machine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asiniy","download_url":"https://codeload.github.com/asiniy/ecto_state_machine/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247557767,"owners_count":20958047,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecto","ecto-state-machine","elixir","elixir-lang"],"created_at":"2024-08-01T02:00:27.522Z","updated_at":"2025-04-06T22:08:37.217Z","avatar_url":"https://github.com/asiniy.png","language":"Elixir","funding_links":[],"categories":["Algorithms and Data structures"],"sub_categories":[],"readme":"# Ecto state machine\n\n![travis ci badge](https://travis-ci.org/asiniy/ecto_state_machine.svg)\n![badge](https://img.shields.io/hexpm/v/ecto_state_machine.svg)\n\nThis package allows to use [finite state machine pattern](https://en.wikipedia.org/wiki/Finite-state_machine) in Ecto. Specify:\n\n* states\n* events\n* column ([optional](#custom-column-name))\n\nand go:\n\n``` elixir\ndefmodule User do\n  use Web, :model\n\n  use EctoStateMachine,\n    states: [:unconfirmed, :confirmed, :blocked, :admin],\n    events: [\n      [\n        name:     :confirm,\n        from:     [:unconfirmed],\n        to:       :confirmed,\n        callback: fn(model) -\u003e Ecto.Changeset.change(model, confirmed_at: Ecto.DateTime.utc) end # yeah you can bring your own code to these functions.\n      ], [\n        name:     :block,\n        from:     [:confirmed, :admin],\n        to:       :blocked\n      ], [\n        name:     :make_admin,\n        from:     [:confirmed],\n        to:       :admin\n      ]\n    ]\n\n  schema \"users\" do\n    field :state, :string, default: \"unconfirmed\"\n  end\nend\n```\n\nnow you can do:\n\n``` elixir\nuser = Repo.get_by(User, id: 1)\n\n# Create changeset transition user state to \"confirmed\". We can make him admin!\nconfirmed_user = User.confirm(user)     # =\u003e\n\n# We can validate ability to change user's state\nUser.can_confirm?(confirmed_user)       # =\u003e false\nUser.can_make_admin?(confirmed_user)    # =\u003e true\n\n# Create changeset transition user state to \"admin\"\nadmin = User.make_admin(confirmed_user)\n\n# Store changeset to the database\nRepo.update(admin)                      \n\n\n# List all possible states\n# If column isn't `:state`, function name will be prefixed. IE,\n# for column `:rules` function name will be `rules_states`\nUser.states # =\u003e [:unconfirmed, :confirmed, :blocked, :admin]\n\n# List all possible events\n# If column isn't `:state`, function name will be prefixed. IE,\n# for column `:rules` function name will be `rules_events`\nUser.events # =\u003e [:confirm, :block, :make_admin]\n```\n\nYou can check out whole `test/dummy` directory to inspect how to organize sample app.\n\n## Installation\n\nIf [available in Hex](https://hex.pm/docs/publish), the package can be installed as:\n\n  1. Add ecto_state_machine to your list of dependencies in `mix.exs`:\n\n        def deps do\n          [{:ecto_state_machine, \"~\u003e 0.1.0\"}]\n        end\n\n### Custom column name\n\n`ecto_state_machine` uses `state` database column by default. You can specify\n`column` option to change it. Like this:\n\n``` elixir\ndefmodule Dummy.User do\n  use Dummy.Web, :model\n\n  use EctoStateMachine,\n    column: :rules,\n    # bla-bla-bla\nend\n```\n\nNow your state will be stored into `rules` column.\n\n## Contributions\n\n1. Install dependencies `mix deps.get`\n1. Setup your `config/test.exs` \u0026 `config/dev.exs`\n1. Run migrations `mix ecto.migrate` \u0026 `MIX_ENV=test mix ecto.migrate`\n1. Develop new feature\n1. Write new tests\n1. Test it: `mix test`\n1. Open new PR!\n\n## Roadmap to 1.0\n\n- [x] Cover by tests\n- [x] Custom db column name\n- [x] Validation method for changeset indicates its value in the correct range\n- [x] Initial value\n- [x] CI\n- [x] Add status? methods\n- [ ] Introduce it at elixir-radar and my blog\n- [ ] Custom error messages for changeset (with translations by gettext ability)\n- [x] Rely on last versions of ecto \u0026 elixir\n- [ ] Write dedicated module instead of requiring everything into the model\n- [ ] Write bang! methods which are raising exception instead of returning invalid changeset\n- [ ] Rewrite spaghetti description in README\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasiniy%2Fecto_state_machine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasiniy%2Fecto_state_machine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasiniy%2Fecto_state_machine/lists"}