{"id":15588485,"url":"https://github.com/hopsoft/state_jacket","last_synced_at":"2025-07-22T20:33:59.062Z","repository":{"id":6412644,"uuid":"7650946","full_name":"hopsoft/state_jacket","owner":"hopsoft","description":"A simple \u0026 intuitive state machine","archived":false,"fork":false,"pushed_at":"2025-06-15T00:04:07.000Z","size":283,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-25T16:02:08.767Z","etag":null,"topics":["ruby","state-machine","state-transitions"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hopsoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-01-16T18:05:55.000Z","updated_at":"2025-02-06T04:32:04.000Z","dependencies_parsed_at":"2022-08-26T03:52:15.029Z","dependency_job_id":null,"html_url":"https://github.com/hopsoft/state_jacket","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/hopsoft/state_jacket","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hopsoft%2Fstate_jacket","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hopsoft%2Fstate_jacket/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hopsoft%2Fstate_jacket/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hopsoft%2Fstate_jacket/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hopsoft","download_url":"https://codeload.github.com/hopsoft/state_jacket/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hopsoft%2Fstate_jacket/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266567638,"owners_count":23949391,"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","status":"online","status_checked_at":"2025-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ruby","state-machine","state-transitions"],"created_at":"2024-10-02T22:40:27.248Z","updated_at":"2025-07-22T20:33:59.028Z","avatar_url":"https://github.com/hopsoft.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Lines of Code](http://img.shields.io/badge/lines_of_code-130-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)\n[![Maintainability](https://api.codeclimate.com/v1/badges/14c24e331928eca7c724/maintainability)](https://codeclimate.com/github/hopsoft/state_jacket/maintainability)\n[![Build Status](http://img.shields.io/travis/hopsoft/state_jacket.svg?style=flat)](https://travis-ci.org/hopsoft/state_jacket)\n[![Coverage Status](https://img.shields.io/coveralls/hopsoft/state_jacket.svg?style=flat)](https://coveralls.io/r/hopsoft/state_jacket?branch=master)\n[![Downloads](http://img.shields.io/gem/dt/state_jacket.svg?style=flat)](http://rubygems.org/gems/state_jacket)\n\n# StateJacket\n\n## An Intuitive [State Transition System](http://en.wikipedia.org/wiki/State_transition_system) \u0026 [State Machine](https://en.wikipedia.org/wiki/Finite-state_machine)\n\nStateJacket provides an intuitive approach to building complex state machines\nby isolating the concerns of the state transition system \u0026 state machine.\n\n## Install\n\n```sh\ngem install state_jacket\n```\n\n## Example\n\nLet's define states \u0026 transitions (i.e. the state transition system) \u0026 a state machine for a [turnstyle](http://en.wikipedia.org/wiki/Finite-state_machine#Example:_a_turnstile).\n\n![Turnstyle](https://raw.github.com/hopsoft/state_jacket/master/doc/turnstyle.png)\n\n### State Transition System\n\n```ruby\nsystem = StateJacket::StateTransitionSystem.new\nsystem.add :opened =\u003e [:closed, :errored]\nsystem.add :closed =\u003e [:opened, :errored]\nsystem.lock # prevent further changes\n\nsystem.to_h.inspect  # =\u003e {\"opened\"=\u003e[\"closed\", \"errored\"], \"closed\"=\u003e[\"opened\", \"errored\"], \"errored\"=\u003enil}\nsystem.transitioners # =\u003e [\"opened\", \"closed\"]\nsystem.terminators   # =\u003e [\"errored\"]\n\nsystem.can_transition? :opened =\u003e :closed  # =\u003e true\nsystem.can_transition? :closed =\u003e :opened  # =\u003e true\nsystem.can_transition? :errored =\u003e :opened # =\u003e false\nsystem.can_transition? :errored =\u003e :closed # =\u003e false\n```\n\n### State Machine\n\nDefine the events that trigger transitions defined by the state transition system (i.e. the state machine).\n\n```ruby\nmachine = StateJacket::StateMachine.new(system, state: \"closed\")\nmachine.on :open, :closed =\u003e :opened\nmachine.on :close, :opened =\u003e :closed\nmachine.lock # prevent further changes\n\nmachine.to_h.inspect # =\u003e {\"open\"=\u003e[{\"closed\"=\u003e\"opened\"}], \"close\"=\u003e[{\"opened\"=\u003e\"closed\"}]}\nmachine.events       # =\u003e [\"open\", \"close\"]\n\nmachine.state            # =\u003e \"closed\"\nmachine.is_event? :open  # =\u003e true\nmachine.is_event? :close # =\u003e true\nmachine.is_event? :other # =\u003e false\n\nmachine.can_trigger? :open # =\u003e true\nmachine.can_trigger? :close # =\u003e false\n\nmachine.state         # =\u003e \"closed\"\nmachine.trigger :open # =\u003e \"opened\"\nmachine.state         # =\u003e \"opened\"\n\n# you can also pass a block when triggering events\nmachine.trigger :close do |from_state, to_state|\n  # custom logic can be placed here\n  from_state # =\u003e \"opened\"\n  to_state   # =\u003e \"closed\"\nend\n\nmachine.state # =\u003e \"closed\"\n\n# this is a noop because can_trigger?(:close) is false\nmachine.trigger :close # =\u003e nil\n\nmachine.state # =\u003e \"closed\"\n\nbegin\n  machine.trigger :open do |from_state, to_state|\n    raise # the transition isn't performed if an error occurs in the block\n  end\nrescue\nend\n\nmachine.state # =\u003e \"closed\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhopsoft%2Fstate_jacket","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhopsoft%2Fstate_jacket","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhopsoft%2Fstate_jacket/lists"}