These requirements and the initial state of the code are extracted from the original GitHub repository
Hi and welcome to team Gilded Rose. As you know, we are a small inn with a prime location in a
prominent city run 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, 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 aSellIn
value which denotes the number of days we have to sell theitems
- All
items
have aQuality
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" increases in
Quality
the older it gets - The
Quality
of an item is never more than50
- "Sulfuras", being a legendary item, never has to be sold or decreases in
Quality
- "Backstage passes", like aged brie, increases in
Quality
as itsSellIn
value approaches;Quality
increases by2
when there are10
days or less and by3
when there are5
days or less butQuality
drops to0
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.
The main objective of this kata is:
- Understand how good testing can help to refactor code
- Identify code smells
- Use IDE refactor tools to improve the code
- Be able to refactor step by step the code so a new item can be added as easily as possible.
The project can be configured either by using pip
or pipenv
. Both ways will be explained.
Using pip
- Create a virtual environment:
python -m venv .venv
- Activate the virtual environment:
source .venv/bin/activate # Linux / Mac .venv\Scripts\activate # Windows
- Install the dependencies:
pip install -r requirements.txt
Using pipenv
-
Install pipenv:
pip install pipenv
-
Create a virtual environment with desire python version
pipenv --python 3.11
By default it will create the virtual environment outside the project. To create it inside the project, use the following command:
PIPENV_VENV_IN_PROJECT=1 pipenv --python 3.11
-
Install the dependencies:
pipenv install
To run the tests, execute one of the following commands:
pytest
or
pipenv run test