Gilded Rose Refactoring Kata

This Kata was originally created by Terry Hughes (http://twitter.com/TerryHughes). It is already on GitHub here. See also Bobby Johnson's description of the 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)

As Bobby Johnson points out in his article "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.

I wrote this article "Writing Good Tests for the Gilded Rose Kata" about how you could use this kata in a coding dojo.

How to use this Kata

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" 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.

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.

Alternatively, use the "Text-Based" tests provided in this repository. (Read more about that in the next section)

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.

Text-Based Approval Testing

This code comes with comprehensive tests that use this approach. For information about how to run them, see the texttests README

Get going quickly using Cyber-Dojo

I've also set this kata up on cyber-dojo for several languages, so you can get going really quickly:

To create an individual exercise:

• C#, NUnit
• C++ (g++), GoogleTest
• Java, Cucumber - for this one I've also written some step definitions for you
• Java, JUnit
• Python, unittest
• Ruby, RSpec
• Ruby, testunit

To create a group exercise:

• C#, NUnit
• C++ (g++), GoogleTest
• Java, Cucumber - for this one I've also written some step definitions for you
• Java, JUnit
• Python, unittest
• Ruby, RSpec
• Ruby, testunit

Better Code Hub

I analysed this repo according to the clean code standards on Better Code Hub just to get an independent opinion of how bad the code is. Perhaps unsurprisingly, the compliance score is low!