Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/antononcube/raku-dsl-finitestatemachines

Finite State Machines (FSMs) roles and classes for making conversational agents based on Domain Specific Languages (DSLs).
https://github.com/antononcube/raku-dsl-finitestatemachines

dsl finite-state-machine fsm raku rakulang

Last synced: 21 days ago
JSON representation

Finite State Machines (FSMs) roles and classes for making conversational agents based on Domain Specific Languages (DSLs).

Host: GitHub
URL: https://github.com/antononcube/raku-dsl-finitestatemachines
Owner: antononcube
License: artistic-2.0
Created: 2022-02-13T19:34:58.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-04-24T19:18:49.000Z (9 months ago)
Last Synced: 2024-10-30T01:22:08.483Z (2 months ago)
Topics: dsl, finite-state-machine, fsm, raku, rakulang
Language: Raku
Homepage: https://raku.land/zef:antononcube/DSL::FiniteStateMachines
Size: 314 KB
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README-work.md
- License: LICENSE

Awesome Lists containing this project

README

        # Raku DSL::FiniteStateMachines

    

[![License: Artistic-2.0](https://img.shields.io/badge/License-Artistic_2.0-0298c3.svg)](https://opensource.org/licenses/Artistic-2.0)

## In brief

This repository is for a Raku package with class definitions and functions for 

creation of Finite State Machines (FSMs) and their execution.

-----

## Usage example (Address book)

Here we load the definition of the class `AddressBookCaller` (provided by this package)

and related entities package, 

["DSL::Entity::AddressBook"](https://github.com/antononcube/Raku-DSL-Entity-AddressBook):

```perl6

use DSL::FiniteStateMachines::AddressBookCaller;

use DSL::Entity::AddressBook;

use DSL::Entity::AddressBook::ResourceAccess;

```

Here we obtain a resource object to access a (particular) address book:

```perl6

my $resourceObj = DSL::Entity::AddressBook::resource-access-object();

```

Here we create the FSM and show its states:

```perl6

my DSL::FiniteStateMachines::AddressBookCaller $abcFSM .= new;

$abcFSM.make-machine(($resourceObj,));

.say for $abcFSM.states;

```

(Each pair shows the name of the state object and the object itself.)

Here is the graph of FSM's state transitions:

```perl6, output.prompt=NONE, output-lang=mermaid

$abcFSM.to-mermaid-js

```

**Remark:** In order to obtain a Mathematica -- or Wolfram Language (WL) -- representation of the state transitions

graph the method `to-wl` can be used.

Here is how the dataset of the created FSM looks like:

```perl6

.say for $abcFSM.dataset.pick(3);

```

For an *interactive* execution of the FSM we use the command:

```

#$abcFSM.run('WaitForCallCommand');

```

Here we *run* the FSM with a sequence of commands:

```perl6

$abcFSM.run('WaitForCallCommand', 

        ["call an actor from LOTR", "", 

         "take last three", "", 

         "take the second", "", "", 

         "2", "5", "", 

         "quit"]);

```

------

## Object Oriented Design

Here is the Unified Modeling Language (UML) diagram corresponding to the classes in this package:

```mermaid

classDiagram

class DSL_FiniteStateMachines_DataObtainer {

  +$!FSMGrammar

  +$!acquiredData

  +$!currentStateID

  +$!dataset

  +$!datasetColumnNames

  +$!initDataset

  +$!itemSpec

  +$!itemSpecCommand

  +%!states

  +&!ECHOLOGGING

  +&!choose-transition

  +&!re-say

  +&!re-warn

  +@!grammar-args

  +BUILDALL()

  +ECHOLOGGING()

  +FSMGrammar()

  +acquiredData()

  +add-state()

  +add-transition()

  +apply-query-retrieve-act-pattern()

  +choose-transition()

  +currentStateID()

  +dataset()

  +datasetColumnNames()

  +grammar-args()

  +init-dataset()

  +initDataset()

  +is-metadata-dataset()

  +is-metadata-row()

  +itemSpec()

  +itemSpecCommand()

  +make-machine()

  +re-say()

  +re-warn()

  +run()

  +states()

  +to-wl()

  +transition-target()

}

DSL_FiniteStateMachines_DataObtainer --|> DSL_FiniteStateMachines_FSMish

DSL_FiniteStateMachines_DataObtainer --|> DSL_FiniteStateMachines_QueryRetrieveActFSMRole

class DSL_FiniteStateMachines_State {

  +$!id

  +$!implicitNext

  +&!action

  +@!explicitNext

  +BUILDALL()

  +Str()

  +action()

  +explicitNext()

  +gist()

  +id()

  +implicitNext()

  +to-wl()

}

class DSL_FiniteStateMachines_Transition {

  +$!id

  +$!to

  +BUILDALL()

  +Str()

  +gist()

  +id()

  +to()

}

class DSL_FiniteStateMachines_QueryRetrieveActFSMRole {

  <>

  +$!FSMGrammar

  +$!acquiredData

  +$!dataset

  +$!datasetColumnNames

  +$!initDataset

  +$!itemSpec

  +$!itemSpecCommand

  +@!grammar-args

  +apply-query-retrieve-act-pattern()

  +init-dataset()

  +is-metadata-dataset()

  +is-metadata-row()

}

DSL_FiniteStateMachines_QueryRetrieveActFSMRole --|> DSL_FiniteStateMachines_FSMish

class DSL_FiniteStateMachines_AddressBookCaller {

  +$!FSMGrammar

  +$!acquiredData

  +$!currentStateID

  +$!dataset

  +$!datasetColumnNames

  +$!initDataset

  +$!itemSpec

  +$!itemSpecCommand

  +%!states

  +&!ECHOLOGGING

  +&!choose-transition

  +&!re-say

  +&!re-warn

  +@!grammar-args

  +BUILDALL()

  +ECHOLOGGING()

  +FSMGrammar()

  +acquiredData()

  +add-state()

  +add-transition()

  +apply-query-retrieve-act-pattern()

  +choose-transition()

  +currentStateID()

  +dataset()

  +datasetColumnNames()

  +grammar-args()

  +init-dataset()

  +initDataset()

  +is-metadata-dataset()

  +is-metadata-row()

  +itemSpec()

  +itemSpecCommand()

  +make-machine()

  +re-say()

  +re-warn()

  +run()

  +states()

  +to-wl()

  +transition-target()

}

DSL_FiniteStateMachines_AddressBookCaller --|> DSL_FiniteStateMachines_FSMish

DSL_FiniteStateMachines_AddressBookCaller --|> DSL_FiniteStateMachines_QueryRetrieveActFSMRole

class DSL_FiniteStateMachines_FSMish {

  <>

  +$!currentStateID

  +%!states

  +&!ECHOLOGGING

  +&!choose-transition

  +&!re-say

  +&!re-warn

  +add-state()

  +run()

  +to-wl()

}

```

(The [UML spec](./docs/UML-class-diagram.puml) and the Mermaid spec above were automatically generated with ["UML::Translators"](https://raku.land/zef:antononcube/UML::Translators), [AAp5].)

Here is the MermaidJS spec generation shell command:

```

to-uml-spec --format=MermaidJS DSL::FiniteStateMachines 

```

------

## References

### Packages

[AAp1] Anton Antonov,

[DSL::Shared Raku package](https://github.com/antononcube/Raku-DSL-Shared),

(2020),

[GitHub/antononcube](https://github.com/antononcube).

[AAp2] Anton Antonov,

[DSL::Entity::Metadata Raku package](https://github.com/antononcube/Raku-DSL-Entity-Metadata),

(2021),

[GitHub/antononcube](https://github.com/antononcube).

[AAp3] Anton Antonov,

[DSL::English::DataAcquisitionWorkflows Raku package](https://github.com/antononcube/Raku-DSL-English-DataAcquisitionWorkflows),

(2021),

[GitHub/antononcube](https://github.com/antononcube).

[AAp4] Anton Antonov,

[DSL::Entity::AddressBook Raku package](https://github.com/antononcube/Raku-DSL-Entity-AddressBook),

(2023),

[GitHub/antononcube](https://github.com/antononcube).

[AAp5] Anton Antonov,

[UML::Translators Raku package](https://github.com/antononcube/Raku-UML-Translators),

(2021),

[GitHub/antononcube](https://github.com/antononcube).

### Videos

[AAv1] Anton Antonov,

["Multi-language Data Wrangling and Acquisition Conversational Agents (in Raku)"](https://www.youtube.com/watch?v=3OUkSa-5vEk),

(2021),

[YouTube.com](https://www.youtube.com/channel/UC5qMPIsJeztfARXWdIw3Xzw).