Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rabestro/coffee-machine
This project allows you to better understand the basic OOP, its main concepts such as classes, class methods and attributes, and get a taste of Kotlin.
https://github.com/rabestro/coffee-machine
bdd bdd-framework bdd-style bdd-style-testing-framework bdd-tests kotlin spock spock-framework spock-tests student-project
Last synced: about 2 months ago
JSON representation
This project allows you to better understand the basic OOP, its main concepts such as classes, class methods and attributes, and get a taste of Kotlin.
- Host: GitHub
- URL: https://github.com/rabestro/coffee-machine
- Owner: rabestro
- License: mit
- Created: 2022-10-29T10:04:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T11:05:40.000Z (about 2 years ago)
- Last Synced: 2024-07-30T17:21:51.310Z (5 months ago)
- Topics: bdd, bdd-framework, bdd-style, bdd-style-testing-framework, bdd-tests, kotlin, spock, spock-framework, spock-tests, student-project
- Language: Groovy
- Homepage: https://rabestro.github.io/coffee-machine/
- Size: 236 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://sonarcloud.io/summary/new_code?id=rabestro_coffee-machine)
# Coffee Machine
The repository contains sample tests written using the [Spock Framework](https://spockframework.org/). Tests written to solve an educational project from [JetBrains Academy](https://www.jetbrains.com/academy/). The [main objective](https://hyperskill.org/projects/67/stages/365/implement) of [the project](https://hyperskill.org/projects/67?track=18) was to use objects to simulate the operation of real devices. It was necessary to create a class with a method that takes a string as input. Below are quotes from the problem statement:
> Every time the user inputs a string to the console, the program invokes this method with one argument: the line that the user inputs to the console. This system simulates pretty accurately how real-world electronic devices work. External components (like buttons on the coffee machine or tapping on the screen) generate events that pass into the single interface of the program.
>
> The class should not use system input at all; it will only handle the input that comes to it via this method and its string argument.
>
> The right solution to this problem is to store the current state of the machine. The coffee machine has several states it can be in. For example, the state could be "choosing an action" or "choosing a type of coffee". Every time the user inputs something and a program passes that line to the method, the program determines how to interpret this line using the information about the current state. After processing this line, the state of the coffee machine can be changed or can stay the same.
In this project, this class is called [Control Unit](https://github.com/rabestro/coffee-machine/blob/main/src/main/kotlin/lv/id/jc/machine/unit/ControlUnit.kt). Requests from users are passed to the class by calling `process` method. The control unit itself controls [storage](https://github.com/rabestro/coffee-machine/blob/main/src/main/kotlin/lv/id/jc/machine/unit/StorageUnit.kt) and display. Schemes of interaction between devices are presented in [wiki](https://github.com/rabestro/coffee-machine/wiki) pages.
## Reports
- [Specifications](https://rabestro.github.io/coffee-machine/)
- [Gradle Test Report](https://rabestro.github.io/coffee-machine/test)
- [Code coverage](https://rabestro.github.io/coffee-machine/jacocoHtml)
## Coffee Machine control state diagram
```mermaid
stateDiagram-v2
Menu: Write action
Buy: What do you want to buy?
state Buy {
state coffee <>
coffee --> Espresso: 1
coffee --> Latte : 2
coffee --> Cappuccino: 3
coffee --> [*]: back
[*] --> coffee
}
note right of Buy
I have enough resources, making you a coffee!
end note
note right of Buy
Sorry, not enough water!
end note
Fill: Replenishment
state Fill {
beans: coffee beans
cups: disposable cups
[*] --> water
water --> milk
milk --> beans
beans --> cups
cups --> [*]
}
Remaining: Coffe machine report
note right of Remaining
The coffee machine has:
50 ml of water
465 ml of milk
100 g of coffee beans
8 disposable cups
$557 of money
end note
Take: Withdraw money
note right of Take: I gave you $564
[*] --> Menu
Menu --> Buy : buy
Menu --> Fill: fill
Menu --> Remaining: remaining
Menu --> Take: take
Menu --> [*] : exit
```