Form groups of about 3 people and review Pub.java in nerdschool.bar. Which code smells can you find? Refactor to remove smell(s). There is a small test suite (nerdschool.bar.PubPricesTest.java) that will help you along the way. Introduce more tests if you need them.
You will learn to:
- Identify bad code
- Fix code smells
- Refactor with tests
- IntelliJ Community Edition: IntelliJ Community Edition
- Java dev kit: Java SE Development Kit
❓ Not familiar with IntelliJ? Take a look at the User interface docs and the interactive training course inside IntelliJ.
✏️ Open pom.xml in IntelliJ by selecting Open from the Welcome Screen. You can also use File --> Open --> and then select the pom.xml. (See Open an existing Maven project in the IntelliJ docs for more info about how to open projects.)
✏️ Select Open as Project.
✏️ Run all the tests in the PubPricesTest class and verify that they are all green. (See Run tests in the IntelliJ docs for more info about how to run tests.)
✏️ Examine the tests and the code in the Pub class.
❓ What does this code do? Before you start changing the code, understand what the code does.
❓ What is wrong with the code? There are naming issues, magical numbers, bad structure and more.
The main part of this exercise is to refactor the code. You'll get to do much of this on your own, but here are some fairly small tasks to start with:
✏️ Fix all the magical numbers.
✏️ Rename existing functions so their names reflect what they do.
✏️ Remove bad comments.
✏️ Make functions where appropriate if there are clear bits of the code that are independent of the rest.
From now on you're on your own. There are many ways to refactor this code and not necessarily one correct one. It's useful to discuss whether you see any code that should be separated into and what each class should do.
- Can any of the code structures you've learned about make this code easier to read and easier to maintain?
- If you add more drinks to the menu, how can you make the code support this in the best way possible?