mirror of
https://github.com/emilybache/GildedRose-Refactoring-Kata.git
synced 2026-02-14 22:21:20 +00:00
Make the requirements the content of the README
This commit is contained in:
parent
497ae68108
commit
b99d47471d
@ -1,37 +0,0 @@
|
||||
# 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 `items`
|
||||
- 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.
|
||||
38
README.md
38
README.md
@ -1,3 +1,37 @@
|
||||
### Gilded Rose Requirements
|
||||
# Gilded Rose Requirements Specification
|
||||
|
||||
- [Requirements](GildedRoseRequirements.md)
|
||||
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 `items`
|
||||
- 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.
|
||||
|
||||
@ -1,14 +0,0 @@
|
||||
#!/usr/bin/env python
|
||||
"""
|
||||
This script uses Gradle to execute the TexttestFixture.
|
||||
It is designed to be used by TextTest and specified in the file 'texttests/config.gr' in this repo.
|
||||
It is more convenient for TextTest to use since Gradle needs
|
||||
several arguments in addition to the one the TextTest fixture needs.
|
||||
"""
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
args = " ".join(sys.argv[1:])
|
||||
TEXTTEST_HOME = os.environ.get("TEXTTEST_HOME", os.getcwd())
|
||||
subprocess.run(f"{TEXTTEST_HOME}/Java/gradlew -p {TEXTTEST_HOME}/Java -q text --args {args}", shell=True)
|
||||
Loading…
Reference in New Issue
Block a user