aasm/aasm
Aasm
This library provides a framework for defining finite state machines within Ruby classes to manage complex object lifecycles. It functions as a declarative workflow engine, allowing developers to model object states, events, and transitions through a readable domain-specific language. By integrating directly with database persistence layers, the framework ensures that state changes are synchronized with storage records while maintaining data integrity through transaction management and row locking.
The library distinguishes itself by enforcing strict business rules through conditional transition guards and preventing direct state modification, ensuring that all lifecycle changes occur exclusively through defined events. It supports multiple independent state machines within a single class by mapping them to distinct database fields, providing isolated lifecycle control. Furthermore, it automatically generates dynamic instance methods for querying states and event triggering, alongside database query scopes that simplify filtering objects based on their current status.
Beyond core lifecycle management, the framework includes utilities for state name localization to support multi-language interfaces and provides hooks for executing custom logic before or after transitions. It also offers specialized testing matchers to verify state machine configurations and transition logic within automated test suites. The project includes tools for compiling source code and configurations into structured documentation to assist with system reference.
Features
- State Machine Logic - Provides a framework for defining finite state machines within Ruby classes to manage object lifecycles.
- Business Logic Extensions - Restricts object transitions to predefined paths to ensure business logic compliance throughout the lifecycle.
- Active Record Mappers - Integrates state machine transitions directly with database records using Active Record patterns to ensure data consistency.
- Database Integration Layers - Synchronizes state changes with database records using transactions and locking to maintain data integrity.
- State Modification Restrictions - Prevents direct modification of state storage columns to ensure all lifecycle changes occur exclusively through defined events.
- Declarative Workflow Engines - Models complex object workflows using a declarative domain-specific language to enforce transition rules.
- Transition Guards - Enforces business rules by evaluating conditional predicates that must be satisfied before a state transition is permitted.
- Application State Machines - Allows configuration of states, events, and transitions within a class to control object behavior.
- State Machine Integrations - Integrates state machine logic with database persistence layers to ensure integrity during transitions.
- State Transition Mapping - Maps trigger events to source and destination states to define and enforce consistent object lifecycle flows.
- Conditional Transition Guards - Enforces business rules by evaluating conditional predicates before permitting state transitions.
- Transactional State Persistence - Ensures data consistency by synchronizing state changes with database records using transactional persistence.
- Query Scopes - Automatically generates reusable database query constraints for filtering objects based on their current lifecycle state.
- State Querying - Automatically generates database query scopes for filtering objects based on their current lifecycle status.
- Domain Specific Languages - Provides a declarative domain-specific language for defining complex state machine rules and transitions.
- State Transition Lifecycle Hooks - Executes custom callback logic automatically during specific phases of state transitions.
- State Machine Logic Verifications - Offers specialized testing matchers to verify state machine configurations and transition logic within automated test suites.
- Multi-Machine Configurations - Supports hosting multiple independent state machines within a single class by mapping them to distinct database fields.
- State Lifecycle Callbacks - Triggers custom logic automatically before or after state transitions to perform lifecycle side effects.
- State Transition Validation - Provides utilities to inspect and retrieve valid events available for the current state to determine permissible next steps.
- Lifecycle State Verifications - Provides dynamic methods to verify current states and check if specific lifecycle events are permitted.
- Model Enhancements - State machine implementation for Ruby classes.
- Ruby Frameworks and Tools - State machine library for Ruby.
- State Machines - State machine implementation for Ruby and Rails.
