diff --git a/.bettercodehub.yml b/.bettercodehub.yml deleted file mode 100644 index 5e00bdf0..00000000 --- a/.bettercodehub.yml +++ /dev/null @@ -1,17 +0,0 @@ -exclude: -- /js/lib/.* -component_depth: 1 -languages: -- cpp -- csharp -- go -- groovy -- java -- javascript -- perl -- php -- python -- ruby -- scala -- script -- swift diff --git a/Java/.editorconfig b/.editorconfig similarity index 100% rename from Java/.editorconfig rename to .editorconfig diff --git a/.gitignore b/.gitignore index 95bd72b9..6b8ed5ae 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,13 @@ -bin -obj -*.sln.DotSettings.user -.vs -vendor -.idea +.idea/ *.iml +target/ + +.classpath +.project +bin/ +.settings/ + +# Gradle +.gradle +/build/ + diff --git a/GildedRoseRequirements.txt b/GildedRoseRequirements.txt deleted file mode 100644 index 2e74aae6..00000000 --- a/GildedRoseRequirements.txt +++ /dev/null @@ -1,38 +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 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. diff --git a/Java/.gitignore b/Java/.gitignore deleted file mode 100644 index 31689f2e..00000000 --- a/Java/.gitignore +++ /dev/null @@ -1,13 +0,0 @@ -.idea/ -*.iml -target/ - -.classpath -.project -bin/ -.settings/ - -# Gradle -.gradle -/build/ - diff --git a/Java/readme.md b/Java/readme.md deleted file mode 100644 index 35288a85..00000000 --- a/Java/readme.md +++ /dev/null @@ -1,22 +0,0 @@ -# Gilded Rose Kata in Java - -Forked version of the Gilded-Rose-Refactoring-Kate project, original can be found -[here](https://github.com/emilybache/GildedRose-Refactoring-Kata). - -# Notes - -## Item rules - -* Quality increases or decreases when sell-in days pass or is constant. -* Quality of an item cannot be negative value. -* If item is Legendary, it's quality is always 80 and never changes. - -## Types of items - -| Item name | Quality changes, when day passes | Description | -|:----------|:---------------------------------|:------------- | -| Normal | **Quality decreases by 1;**
**Quality decreases by 2**, when sell-in date approaches | - | -| Aged Brie | **Quality increases by 1;**
**Quality increases by 2**, when sell-in date approaches | - | -| Conjured | Quality decreases by 1;
Quality decreases by 4 when sell-in date approaches | - | -| Backstage Pass | Quality increases by 1;
Quality increases by 2 when there are 10 days or less;
Quality increases by 3 when there are 5 days or less;
Quality drops to 0 after the concert. | - | -| Sulfura | **Always 80**. Never changes| Legendary item. Constant quality value. | diff --git a/README.md b/README.md index 5e666982..77b215bb 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,59 @@ -# Gilded Rose Refactoring Kata +# Gilded Rose Kata in Java -This Kata was originally created by Terry Hughes (http://twitter.com/TerryHughes). It is already on GitHub [here](https://github.com/NotMyself/GildedRose). See also [Bobby Johnson's description of the kata](http://iamnotmyself.com/2011/02/13/refactor-this-the-gilded-rose-kata/). +Forked version of the Gilded-Rose-Refactoring-Kate project, original can be found +[here](https://github.com/emilybache/GildedRose-Refactoring-Kata). -I translated the original C# into a few other languages, (with a little help from my friends!), and slightly changed the starting position. This means I've actually done a small amount of refactoring already compared with the original form of the kata, and made it easier to get going with writing tests by giving you one failing unit test to start with. I also added test fixtures for Text-Based approval testing with TextTest (see [the TextTests](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/master/texttests)) +# Requirements -As Bobby Johnson points out in his article ["Why Most Solutions to Gilded Rose Miss The Bigger Picture"](http://iamnotmyself.com/2012/12/07/why-most-solutions-to-gilded-rose-miss-the-bigger-picture), it'll actually give you -better practice at handling a legacy code situation if you do this Kata in the original C#. However, I think this kata -is also really useful for practicing writing good tests using different frameworks and approaches, and the small changes I've made help with that. I think it's also interesting to compare what the refactored code and tests look like in different programming languages. +## Gilded Rose Requirements Specification -I use this kata as part of my work as a technical coach. I wrote a lot about the coaching method I use in this book [Technical Agile Coaching with the Samman method](https://leanpub.com/techagilecoach). A while back I wrote this article ["Writing Good Tests for the Gilded Rose Kata"](http://coding-is-like-cooking.info/2013/03/writing-good-tests-for-the-gilded-rose-kata/) about how you could use this kata in a [coding dojo](https://leanpub.com/codingdojohandbook). +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: -## How to use this Kata + - 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 -The simplest way is to just clone the code and start hacking away improving the design. You'll want to look at the ["Gilded Rose Requirements"](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/master/GildedRoseRequirements.txt) which explains what the code is for. I strongly advise you that you'll also need some tests if you want to make sure you don't break the code while you refactor. +Pretty simple, right? Well this is where it gets interesting: -You could write some unit tests yourself, using the requirements to identify suitable test cases. I've provided a failing unit test in a popular test framework as a starting point for most languages. + - 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 -Alternatively, use the "Text-Based" tests provided in this repository. (Read more about that in the next section) +We have recently signed a supplier of conjured items. This requires an update to our system: -Whichever testing approach you choose, the idea of the exercise is to do some deliberate practice, and improve your skills at designing test cases and refactoring. The idea is not to re-write the code from scratch, but rather to practice designing tests, taking small steps, running the tests often, and incrementally improving the design. + - "Conjured" items degrade in Quality twice as fast as normal items -### Gilded Rose Requirements in other languages +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). -- [English](GildedRoseRequirements.txt) -- [Español](GildedRoseRequirements_es.md) -- [Français](GildedRoseRequirements_fr.md) -- [日本語](GildedRoseRequirements_jp.md) -- [Português](GildedRoseRequirements_pt-BR.md) -- [Русский](GildedRoseRequirements_ru.txt) -- [ไทย](GildedRoseRequirements_th.md) -- [中文](GildedRoseRequirements_zh.txt) -- [한국어](GildedRoseRequirements_kr.md) +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. -## Text-Based Approval Testing +# Notes -This code comes with comprehensive tests that use this approach. For information about how to run them, see the [texttests README](https://github.com/emilybache/GildedRose-Refactoring-Kata/tree/master/texttests) +## Item rules -## Translating this code +* Quality increases or decreases when sell-in days pass or is constant. +* Quality of an item cannot be negative value. +* If item is Legendary, it's quality is always 80 and never changes. -More translations are most welcome! I'm very open for pull requests that translate the starting position into additional languages. +## Types of items -Please note a translation should ideally include: - -- a translation of the production code for 'update_quality' and Item -- one failing unit test complaining that "fixme" != "foo" -- a TextTest fixture, ie a command-line program that runs update_quality on the sample data for the number of days specified. - -Please don't write too much code in the starting position or add too many unit tests. The idea with the one failing unit test is to tempt people to work out how to fix it, discover it wasn't that hard, and now they understand what this test is doing they realize they can improve it. - -If your programming language doesn't have an easy way to add a command-line interface, then the TextTest fixture is probably not necessary. - -## Better Code Hub - -I analysed this repo according to the clean code standards on [Better Code Hub](https://bettercodehub.com) just to get an independent opinion of how bad the code is. Perhaps unsurprisingly, the compliance score is low! - -[![BCH compliance](https://bettercodehub.com/edge/badge/emilybache/GildedRose-Refactoring-Kata?branch=master)](https://bettercodehub.com/) +| Item name | Quality changes, when day passes | Description | +|:----------|:---------------------------------|:------------- | +| Normal | **Quality decreases by 1;**
**Quality decreases by 2**, when sell-in date approaches | - | +| Aged Brie | **Quality increases by 1;**
**Quality increases by 2**, when sell-in date approaches | - | +| Conjured | Quality decreases by 1;
Quality decreases by 4 when sell-in date approaches | - | +| Backstage Pass | Quality increases by 1;
Quality increases by 2 when there are 10 days or less;
Quality increases by 3 when there are 5 days or less;
Quality drops to 0 after the concert. | - | +| Sulfura | **Always 80**. Never changes| Legendary item. Constant quality value. | diff --git a/Java/build.gradle b/build.gradle similarity index 100% rename from Java/build.gradle rename to build.gradle diff --git a/Java/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar similarity index 100% rename from Java/gradle/wrapper/gradle-wrapper.jar rename to gradle/wrapper/gradle-wrapper.jar diff --git a/Java/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties similarity index 100% rename from Java/gradle/wrapper/gradle-wrapper.properties rename to gradle/wrapper/gradle-wrapper.properties diff --git a/Java/gradlew b/gradlew old mode 100755 new mode 100644 similarity index 100% rename from Java/gradlew rename to gradlew diff --git a/Java/gradlew.bat b/gradlew.bat similarity index 100% rename from Java/gradlew.bat rename to gradlew.bat diff --git a/license.txt b/license.txt deleted file mode 100644 index 1eebd817..00000000 --- a/license.txt +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2015 @emilybache - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file diff --git a/Java/pom.xml b/pom.xml similarity index 100% rename from Java/pom.xml rename to pom.xml diff --git a/Java/settings.gradle b/settings.gradle similarity index 100% rename from Java/settings.gradle rename to settings.gradle diff --git a/Java/src/main/java/com/gildedrose/item_helpers/ItemFactory.java b/src/main/java/com/gildedrose/item_helpers/ItemFactory.java similarity index 100% rename from Java/src/main/java/com/gildedrose/item_helpers/ItemFactory.java rename to src/main/java/com/gildedrose/item_helpers/ItemFactory.java diff --git a/Java/src/main/java/com/gildedrose/item_helpers/ItemHandler.java b/src/main/java/com/gildedrose/item_helpers/ItemHandler.java similarity index 100% rename from Java/src/main/java/com/gildedrose/item_helpers/ItemHandler.java rename to src/main/java/com/gildedrose/item_helpers/ItemHandler.java diff --git a/Java/src/main/java/com/gildedrose/item_helpers/ItemName.java b/src/main/java/com/gildedrose/item_helpers/ItemName.java similarity index 100% rename from Java/src/main/java/com/gildedrose/item_helpers/ItemName.java rename to src/main/java/com/gildedrose/item_helpers/ItemName.java diff --git a/Java/src/main/java/com/gildedrose/item_helpers/ItemType.java b/src/main/java/com/gildedrose/item_helpers/ItemType.java similarity index 100% rename from Java/src/main/java/com/gildedrose/item_helpers/ItemType.java rename to src/main/java/com/gildedrose/item_helpers/ItemType.java diff --git a/Java/src/main/java/com/gildedrose/items/AgedBrieItem.java b/src/main/java/com/gildedrose/items/AgedBrieItem.java similarity index 100% rename from Java/src/main/java/com/gildedrose/items/AgedBrieItem.java rename to src/main/java/com/gildedrose/items/AgedBrieItem.java diff --git a/Java/src/main/java/com/gildedrose/items/BackstagePassItem.java b/src/main/java/com/gildedrose/items/BackstagePassItem.java similarity index 100% rename from Java/src/main/java/com/gildedrose/items/BackstagePassItem.java rename to src/main/java/com/gildedrose/items/BackstagePassItem.java diff --git a/Java/src/main/java/com/gildedrose/items/ConjuredItem.java b/src/main/java/com/gildedrose/items/ConjuredItem.java similarity index 100% rename from Java/src/main/java/com/gildedrose/items/ConjuredItem.java rename to src/main/java/com/gildedrose/items/ConjuredItem.java diff --git a/Java/src/main/java/com/gildedrose/items/LegendaryItem.java b/src/main/java/com/gildedrose/items/LegendaryItem.java similarity index 100% rename from Java/src/main/java/com/gildedrose/items/LegendaryItem.java rename to src/main/java/com/gildedrose/items/LegendaryItem.java diff --git a/Java/src/main/java/com/gildedrose/items/NormalItem.java b/src/main/java/com/gildedrose/items/NormalItem.java similarity index 100% rename from Java/src/main/java/com/gildedrose/items/NormalItem.java rename to src/main/java/com/gildedrose/items/NormalItem.java diff --git a/Java/src/main/java/com/gildedrose/main/GildedRose.java b/src/main/java/com/gildedrose/main/GildedRose.java similarity index 100% rename from Java/src/main/java/com/gildedrose/main/GildedRose.java rename to src/main/java/com/gildedrose/main/GildedRose.java diff --git a/Java/src/main/java/com/gildedrose/main/Item.java b/src/main/java/com/gildedrose/main/Item.java similarity index 100% rename from Java/src/main/java/com/gildedrose/main/Item.java rename to src/main/java/com/gildedrose/main/Item.java diff --git a/Java/src/test/java/com/gildedrose/items/helper/TestHelper.java b/src/test/java/com/gildedrose/items/helper/TestHelper.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/helper/TestHelper.java rename to src/test/java/com/gildedrose/items/helper/TestHelper.java diff --git a/Java/src/test/java/com/gildedrose/items/items/AgedBrieItemTest.java b/src/test/java/com/gildedrose/items/items/AgedBrieItemTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/items/AgedBrieItemTest.java rename to src/test/java/com/gildedrose/items/items/AgedBrieItemTest.java diff --git a/Java/src/test/java/com/gildedrose/items/items/BackstagePassItemTest.java b/src/test/java/com/gildedrose/items/items/BackstagePassItemTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/items/BackstagePassItemTest.java rename to src/test/java/com/gildedrose/items/items/BackstagePassItemTest.java diff --git a/Java/src/test/java/com/gildedrose/items/items/ConjuredItemTest.java b/src/test/java/com/gildedrose/items/items/ConjuredItemTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/items/ConjuredItemTest.java rename to src/test/java/com/gildedrose/items/items/ConjuredItemTest.java diff --git a/Java/src/test/java/com/gildedrose/items/items/LegendaryItemTest.java b/src/test/java/com/gildedrose/items/items/LegendaryItemTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/items/LegendaryItemTest.java rename to src/test/java/com/gildedrose/items/items/LegendaryItemTest.java diff --git a/Java/src/test/java/com/gildedrose/items/items/NormalItemTest.java b/src/test/java/com/gildedrose/items/items/NormalItemTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/items/NormalItemTest.java rename to src/test/java/com/gildedrose/items/items/NormalItemTest.java diff --git a/Java/src/test/java/com/gildedrose/items/main/ItemClassTest.java b/src/test/java/com/gildedrose/items/main/ItemClassTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/main/ItemClassTest.java rename to src/test/java/com/gildedrose/items/main/ItemClassTest.java diff --git a/Java/src/test/java/com/gildedrose/items/multiple_items/MultipleItemsTest.java b/src/test/java/com/gildedrose/items/multiple_items/MultipleItemsTest.java similarity index 100% rename from Java/src/test/java/com/gildedrose/items/multiple_items/MultipleItemsTest.java rename to src/test/java/com/gildedrose/items/multiple_items/MultipleItemsTest.java