Starting code for the GildedRose Refactoring Kata in many programming languages.
JavaScript Smalltalk ABAP Java Common Lisp C++ Other
Latest commit e916fdd Feb 14, 2017 @emilybache committed on GitHub Merge pull request #56 from dbuschman7/master
upgraded Scala version to latest versions
Permalink
Failed to load latest commit information.
.idea Add Groovy sources and IntelliJ project May 14, 2016
C Removed all the code except for the GildedRose kata from this repo Jun 10, 2013
Groovy improve instructions for IDEs May 14, 2016
Java - Spock + Add new project with pre-configured Gradle as build tool and Spock … Jul 5, 2016
Java reverted GildedRose to original code Jan 11, 2017
Kotlin Ignored various idea files Aug 26, 2016
R Eclipse/StatET R environment configuration (can be imported as existing Dec 5, 2014
Smalltalk Removed all the code except for the GildedRose kata from this repo Jun 10, 2013
abap starting code and tests for ABAP Mar 21, 2016
clisp Common Lisp version by Rainer Joswig Jun 2, 2016
cpp improved installation instructions Jan 22, 2016
csharp Removed all the code except for the GildedRose kata from this repo Jun 10, 2013
dart removed pubspec.lock Mar 19, 2016
elixir Implement a working version of the original code for the kata Oct 15, 2016
fsharp add fsharp version Oct 26, 2015
go Fix filename of gilded-rose.go Nov 7, 2016
haskell Add Haskell port Feb 24, 2015
js Updates examples using ES2015 class syntax Feb 10, 2017
perl add texttest fixture for Perl 5 code May 2, 2014
php add missing texttest fixture for PHP code Apr 13, 2014
plsql turn serveroutput on so we see the results of the texttest fixture Jul 8, 2014
python Remove extra whitespaces Jun 27, 2015
ruby should syntax is deprecated, changed the first test to expect syntax Aug 2, 2016
rust Add rust version Oct 3, 2015
scala upgraded Scala version to latest versions Feb 11, 2017
swift Moved Swift code into package Oct 27, 2016
texttests add texttest fixture for Perl 5 code May 2, 2014
.gitignore Ignore *.pyc files Jun 27, 2015
GildedRoseRequirements.txt fix typo in requirements Jan 25, 2016
GildedRoseRequirements_es.md Adds the spanish translation Feb 10, 2017
GildedRoseRequirements_fr.md refactor: french specification review Oct 15, 2015
GildedRoseRequirements_ru.txt Added requirements specification in russian language. Jun 11, 2016
GildedRoseRequirements_zh.txt Correct spelling of Chinese translation Jun 27, 2016
README.md added C++ cyber-dojo link Jun 8, 2016
license.txt added MIT license Jul 7, 2015

README.md

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 is a testing approach which is very useful when refactoring legacy code. Before you change the code, you run it, and gather the output of the code as a plain text file. You review the text, and if it correctly describes the behaviour as you understand it, you can "approve" it, and save it as a "Golden Master". Then after you change the code, you run it again, and compare the new output against the Golden Master. Any differences, and the test fails.

It's basically the same idea as "assertEquals(expected, actual)" in a unit test, except the text you are comparing is typically much longer, and the "expected" value is saved from actual output, rather than being defined in advance.

Typically a piece of legacy code may not produce suitable textual output from the start, so you may need to modify it before you can write your first text-based approval test. That could involve inserting log statements into the code, or just writing a "main" method that executes the code and prints out what the result is afterwards. It's this latter approach we are using here to test GildedRose.

The Text-Based tests in this repository are designed to be used with the tool "TextTest" (http://texttest.org). This tool helps you to organize and run text-based tests. There is more information in the README file in the "texttests" subdirectory.

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: