https://github.com/aneveux/funktional-parser
🔍 Simple implementation of a functional parser allowing to compute calculation expressions.
https://github.com/aneveux/funktional-parser
exercise functional kotlin parser
Last synced: about 1 year ago
JSON representation
🔍 Simple implementation of a functional parser allowing to compute calculation expressions.
- Host: GitHub
- URL: https://github.com/aneveux/funktional-parser
- Owner: aneveux
- License: apache-2.0
- Created: 2020-04-01T17:25:08.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-06-20T22:44:49.000Z (about 4 years ago)
- Last Synced: 2025-02-09T18:14:38.344Z (over 1 year ago)
- Topics: exercise, functional, kotlin, parser
- Language: Kotlin
- Homepage:
- Size: 33.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Funktional Parser
---
This project is a Kotlin implementation of a functional parser, mainly made for practicing with development techniques and learning about new things.
## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Deployment](#deployment)
- [Usage](#usage)
- [Built Using](#built_using)
- [TODO](../TODO.md)
- [Contributing](../CONTRIBUTING.md)
- [Authors](#authors)
- [Acknowledgments](#acknowledgement)
This small project is an idea from @jmdesprez: implementing in Kotlin a functional parser as presented in [that Youtube video](https://youtu.be/dDtZLm7HIJs).
In the video, the presented parser is implemented in Haskell. Our goal with Jean-Marc was to implement a similar kind of parser in Kotlin.
The aim of the parser we're developing is actually fairly simple: it should allow to parse expressions such as `(1+3*(2+4)*2+4-(2*4))` and be able to calculate the actual result. The parser computation should also validate the expression by parsing only things which are allowed.
If you'd like to discover what we did or play a bit with the source code as well, you can have a look at our test file located in `src/test/kotlin` to understand how we built our parser.
The actual implementation is located in `src/main/kotlin`.
Do not hesitate to have a look at each commit to understand the evolution of the parser. Each brick has been added in a dedicated commit.
### Prerequisites
We decided to stick with the basic Kotlin SDK, and KotlinTest for writing our unit tests.
### Installing
This project retrieves its dependencies from Maven. We developed it using IntelliJ IDEA. There's basically nothing much needed for running the project or contributing to it.
Simply running `mvn test` should be sufficient to execute the unit tests.
We do not recommend to use the functions we developed in a production project since they're completely dedicated to our practice exercise.
But you can use our functions or code to write your own parser or practice yourself.
The project won't be deployed anywhere, and we'll just share the source code here on GitHub.
- [Kotlin](https://kotlinlang.org/)
- [KotlinTest](https://github.com/kotest/kotest)
- [@aneveux](https://github.com/aneveux)
- [@jmdesprez](https://github.com/jmdesprez)
- [Professor Graham Hutton for his explanations and presentation](https://youtu.be/dDtZLm7HIJs)