{"id":1815,"url":"https://github.com/inamiy/RxAutomaton","last_synced_at":"2025-08-02T04:32:40.882Z","repository":{"id":51396653,"uuid":"65905888","full_name":"inamiy/RxAutomaton","owner":"inamiy","description":"🤖 RxSwift + State Machine, inspired by Redux and Elm.","archived":true,"fork":false,"pushed_at":"2021-12-12T05:06:19.000Z","size":336,"stargazers_count":714,"open_issues_count":4,"forks_count":31,"subscribers_count":19,"default_branch":"swift/5.0","last_synced_at":"2025-07-16T02:34:57.810Z","etag":null,"topics":["automaton","elm","redux","rxswift","state-machine","swift"],"latest_commit_sha":null,"homepage":"","language":"Swift","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/inamiy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-17T12:30:05.000Z","updated_at":"2025-04-30T09:15:47.000Z","dependencies_parsed_at":"2022-09-09T21:01:02.660Z","dependency_job_id":null,"html_url":"https://github.com/inamiy/RxAutomaton","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/inamiy/RxAutomaton","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inamiy%2FRxAutomaton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inamiy%2FRxAutomaton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inamiy%2FRxAutomaton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inamiy%2FRxAutomaton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inamiy","download_url":"https://codeload.github.com/inamiy/RxAutomaton/tar.gz/refs/heads/swift/5.0","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inamiy%2FRxAutomaton/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268334618,"owners_count":24233793,"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-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["automaton","elm","redux","rxswift","state-machine","swift"],"created_at":"2024-01-05T20:15:56.456Z","updated_at":"2025-08-02T04:32:40.390Z","avatar_url":"https://github.com/inamiy.png","language":"Swift","readme":"## NOTE: This repository has been discontinued in favor of [Actomaton](https://github.com/inamiy/Actomaton).\n\n# RxAutomaton\n\n[RxSwift](https://github.com/ReactiveX/RxSwift) port of [ReactiveAutomaton](https://github.com/inamiy/ReactiveAutomaton) (State Machine).\n\n\u003e\n\u003e ### Terminology\n\u003e\n\u003e Whenever the word \"signal\" or \"(signal) producer\" appears (derived from [ReactiveCocoa](https://github.com/ReactiveCocoa/ReactiveCocoa)), they mean \"hot-observable\" and \"cold-observable\".\n\n## Example\n\n(Demo app is bundled in the project)\n\n![](Assets/login-diagram.png)\n\nTo make a state transition diagram like above _with additional effects_, follow these steps:\n\n```swift\n// 1. Define `State`s and `Input`s.\nenum State {\n    case loggedOut, loggingIn, loggedIn, loggingOut\n}\n\nenum Input {\n    case login, loginOK, logout, logoutOK\n    case forceLogout\n}\n\n// Additional effects (`Observable`s) while state-transitioning.\n// (NOTE: Use `Observable.empty()` for no effect)\nlet loginOKProducer = /* show UI, setup DB, request APIs, ..., and send `Input.loginOK` */\nlet logoutOKProducer = /* show UI, clear cache, cancel APIs, ..., and send `Input.logoutOK` */\nlet forcelogoutOKProducer = /* do something more special, ..., and send `Input.logoutOK` */\n\nlet canForceLogout: State -\u003e Bool = [.loggingIn, .loggedIn].contains\n\n// 2. Setup state-transition mappings.\nlet mappings: [Automaton\u003cState, Input\u003e.EffectMapping] = [\n\n  /*  Input      |   fromState =\u003e toState        |      Effect       */\n  /* ----------------------------------------------------------------*/\n    .login       | .loggedOut  =\u003e .loggingIn     | loginOKProducer,\n    .loginOK     | .loggingIn  =\u003e .loggedIn      | .empty(),\n    .logout      | .loggedIn   =\u003e .loggingOut    | logoutOKProducer,\n    .logoutOK    | .loggingOut =\u003e .loggedOut     | .empty(),\n    .forceLogout | canForceLogout =\u003e .loggingOut | forceLogoutOKProducer\n]\n\n// 3. Prepare input pipe for sending `Input` to `Automaton`.\nlet (inputSignal, inputObserver) = Observable\u003cInput\u003e.pipe()\n\n// 4. Setup `Automaton`.\nlet automaton = Automaton(\n    state: .loggedOut,\n    input: inputSignal,\n    mapping: reduce(mappings),  // combine mappings using `reduce` helper\n    strategy: .latest   // NOTE: `.latest` cancels previous running effect\n)\n\n// Observe state-transition replies (`.success` or `.failure`).\nautomaton.replies.subscribe(next: { reply in\n    print(\"received reply = \\(reply)\")\n})\n\n// Observe current state changes.\nautomaton.state.asObservable().subscribe(next: { state in\n    print(\"current state = \\(state)\")\n})\n```\n\nAnd let's test!\n\n```swift\nlet send = inputObserver.onNext\n\nexpect(automaton.state.value) == .loggedIn    // already logged in\nsend(Input.logout)\nexpect(automaton.state.value) == .loggingOut  // logging out...\n// `logoutOKProducer` will automatically send `Input.logoutOK` later\n// and transit to `State.loggedOut`.\n\nexpect(automaton.state.value) == .loggedOut   // already logged out\nsend(Input.login)\nexpect(automaton.state.value) == .loggingIn   // logging in...\n// `loginOKProducer` will automatically send `Input.loginOK` later\n// and transit to `State.loggedIn`.\n\n// 👨🏽 \u003c But wait, there's more!\n// Let's send `Input.forceLogout` immediately after `State.loggingIn`.\n\nsend(Input.forceLogout)                       // 💥💣💥\nexpect(automaton.state.value) == .loggingOut  // logging out...\n// `forcelogoutOKProducer` will automatically send `Input.logoutOK` later\n// and transit to `State.loggedOut`.\n```\n\n## License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["Reactive Programming","Libraries"],"sub_categories":["Other free courses","Prototyping","Other Parsing"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finamiy%2FRxAutomaton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finamiy%2FRxAutomaton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finamiy%2FRxAutomaton/lists"}