How bertilmuth/requirementsascode works
Requirements as Code is a Java library for expressing message-handling behavior as models, then running that behavior either statelessly or as stateful actor use cases. The main workflow is to build a model of use cases, flows, and steps; dispatch incoming messages to eligible system reactions; and optionally publish results or route messages to another behavior. The repository also includes a FreeMarker model-to-text extractor and illustrative integrations. Edges reflect README statements or shown source/index references; unsampled subsystems are represented without speculative internal links.
Main entry points: Model.java Model · ModelRunner.java Model runner · FreeMarkerEngine.java FreeMarker engine · Flow.java Flows
Components 23
Behavior modeling
- Behavior model
requirementsascodecore/src/main/java/org/requirementsascode/BehaviorModel.java - Model
requirementsascodecore/src/main/java/org/requirementsascode/Model.java - Model builder
requirementsascodecore/src/main/java/org/requirementsascode/builder/ModelBuilder.java - Step builder
requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java - Use cases
requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java - Flows
requirementsascodecore/src/main/java/org/requirementsascode/Flow.java - Steps
requirementsascodecore/src/main/java/org/requirementsascode/Step.java - Conditions
requirementsascodecore/src/main/java/org/requirementsascode/Condition.java - Flow positions
requirementsascodecore/src/main/java/org/requirementsascode/flowposition/FlowPosition.java
Execution runtime
- Behavior port
requirementsascodecore/src/main/java/org/requirementsascode/Behavior.java - Stateless behavior
requirementsascodecore/src/main/java/org/requirementsascode/StatelessBehavior.java - Actor
requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java - Model runner
requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java - Event queue
requirementsascodecore/src/main/java/org/requirementsascode/queue/EventQueue.java
Application examples
- Pizza calculator
requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java - Hello World actor
requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java - Credit card controller
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java - Card aggregate
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java - Event store
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/persistence/EventStore.java
Model extraction
- FreeMarker engine
requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java - Template methods
requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/methodmodel/FlowCondition.java - Text output
Other components
- Calling code
Connections 23
- Calling code → Behavior port: sends messages
- Behavior model → Model: provides model
- Model builder → Model: builds model
requirementsascodecore/src/main/java/org/requirementsascode/Model.java - Step builder → Model: configures steps
requirementsascodecore/src/main/java/org/requirementsascode/builder/StepPart.java - Model → Use cases: contains
requirementsascodecore/src/main/java/org/requirementsascode/Model.java - Use cases → Flows: creates flows
requirementsascodecore/src/main/java/org/requirementsascode/UseCase.java - Flows → Steps: selects steps
requirementsascodecore/src/main/java/org/requirementsascode/Flow.java - Steps → Conditions: evaluates
requirementsascodecore/src/main/java/org/requirementsascode/Step.java - Flows → Flow positions: positions flow
requirementsascodecore/src/main/java/org/requirementsascode/Flow.java - Stateless behavior → Behavior model: runs model
- Actor → Model runner: dispatches messages
requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java - Actor → Behavior model: loads model
requirementsascodecore/src/main/java/org/requirementsascode/AbstractActor.java - Model runner → Model: runs model
requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java - Model runner → Steps: selects reaction
requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java - Model runner → Actor: routes message
requirementsascodecore/src/main/java/org/requirementsascode/ModelRunner.java - Pizza calculator → Model: builds model
requirementsascodeexamples/pizzavolumecalculator/src/main/java/pizzavolumecalculator/actor/PizzaVolumeCalculator.java - Hello World actor → Model: builds model
requirementsascodeexamples/helloworld/src/main/java/helloworld/HelloWorld06.java - Credit card controller → Card aggregate: invokes aggregate
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java - Credit card controller → Event store: uses event store
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/controller/CreditCardController.java - Card aggregate → Event store: loads events
requirementsascodeexamples/creditcard_eventsourcing/src/main/java/creditcard_eventsourcing/model/CreditCardAggregateRoot.java - FreeMarker engine → Model: extracts model
requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java - FreeMarker engine → Template methods: registers methods
requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java - FreeMarker engine → Text output: writes text
requirementsascodeextract/src/main/java/org/requirementsascode/extract/freemarker/FreeMarkerEngine.java