mirror of
https://github.com/emilybache/GildedRose-Refactoring-Kata.git
synced 2026-05-13 21:38:01 +00:00
80 lines
3.7 KiB
Markdown
80 lines
3.7 KiB
Markdown
# Gilded Rose starting position in Python
|
|
|
|
For exercise instructions see [top level README](../README.md)
|
|
|
|
Suggestion: create a python virtual environment for this project. See the [documentation](https://docs.python.org/3/library/venv.html)
|
|
|
|
## Run the unit tests from the Command-Line
|
|
|
|
```
|
|
python -m unittest
|
|
```
|
|
|
|
## Run the TextTest fixture from the Command-Line
|
|
|
|
For e.g. 10 days:
|
|
|
|
```
|
|
python texttest_fixture.py 10
|
|
```
|
|
|
|
You should make sure the command shown above works when you execute it in a terminal before trying to use TextTest (see below).
|
|
|
|
|
|
## Run the TextTest approval test that comes with this project
|
|
|
|
There are instructions in the [TextTest Readme](../texttests/README.md) for setting up TextTest. You will need to specify the Python executable and interpreter in [config.gr](../texttests/config.gr). Uncomment these lines:
|
|
|
|
executable:${TEXTTEST_HOME}/python/texttest_fixture.py
|
|
interpreter:python
|
|
|
|
## Run the ApprovalTests.Python test
|
|
|
|
This test uses the framework [ApprovalTests.Python](https://github.com/approvals/ApprovalTests.Python). You will need to install Run it like this:
|
|
|
|
```
|
|
python tests/test_gilded_rose_approvals.py
|
|
```
|
|
|
|
You will need to approve the output file which appears under "approved_files" by renaming it from xxx.received.txt to xxx.approved.txt.
|
|
|
|
The Gilded Rose is a refactoring Kata. The simplest way to start would be to go to the [github repo](https://github.com/emilybache/GildedRose-Refactoring-Kata), clone it and start hacking away! The requirement specifications are below.
|
|
|
|
Gilded Rose Requirements Specification
|
|
======================================
|
|
|
|
Hi and welcome to team Gilded Rose. As you know, we are a small inn with a prime location in a
|
|
prominent city ran by a friendly innkeeper named Allison. We also buy and sell only the finest goods.
|
|
Unfortunately, our goods are constantly degrading in quality as they approach their sell by date. We
|
|
have a system in place that updates our inventory for us. It was developed by a no-nonsense type named
|
|
Leeroy, who has moved on to new adventures. Your task is to add the new feature to our system so that
|
|
we can begin selling a new category of items. First an introduction to our system:
|
|
|
|
- All items have a SellIn value which denotes the number of days we have to sell the item
|
|
- All items have a Quality value which denotes how valuable the item is
|
|
- At the end of each day our system lowers both values for every item
|
|
|
|
Pretty simple, right? Well this is where it gets interesting:
|
|
|
|
- Once the sell by date has passed, Quality degrades twice as fast
|
|
- The Quality of an item is never negative
|
|
- "Aged Brie" actually increases in Quality the older it gets
|
|
- The Quality of an item is never more than 50
|
|
- "Sulfuras", being a legendary item, never has to be sold or decreases in Quality
|
|
- "Backstage passes", like aged brie, increases in Quality as its SellIn value approaches;
|
|
Quality increases by 2 when there are 10 days or less and by 3 when there are 5 days or less but
|
|
Quality drops to 0 after the concert
|
|
|
|
We have recently signed a supplier of conjured items. This requires an update to our system:
|
|
|
|
- "Conjured" items degrade in Quality twice as fast as normal items
|
|
|
|
Feel free to make any changes to the UpdateQuality method and add any new code as long as everything
|
|
still works correctly. However, do not alter the Item class or Items property as those belong to the
|
|
goblin in the corner who will insta-rage and one-shot you as he doesn't believe in shared code
|
|
ownership (you can make the UpdateQuality method and Items property static if you like, we'll cover
|
|
for you).
|
|
|
|
Just for clarification, an item can never have its Quality increase above 50, however "Sulfuras" is a
|
|
legendary item and as such its Quality is 80 and it never alters.
|