Iteration 4: Code Quality and State Pattern

Deadline

Always at 23.59 on the same day as your TA session (Except if another deadline has been agreed with the TA). Consult the deadline for your class on the delivery plan.

Learning Goals

The learning goals of this week are: (a) to analyze and refactor your current code base to clean up at least two methods so they adhere to Robert Martin's (and Henrik Bærbak's) properties of clean code; (b) to use the clean code template to ensure completeness of analysis as well as document it; and (c) to use the State pattern to implement ZetaStone.

Prerequisites

Carefully read FRS § 37.4.1 which outlines the ZetaStone variant.

Kata

Spend the first 15-20 minutes of the class in plenum discussing...

Consider this HotStone endOfTurn() implementation, and find examples of Clean Code principles that are violated.

Time permitting, suggest ways to refactor the code to become more clean.

Exercise

Code Clean Up

Choose two complex aspects (a complex method, or a feature coverede by a small set of methods) from your current HotStone implementation and for each first analyze it in terms of the Clean Code template, and next refactor it so it adheres as best as possible to the Clean Code properties. (endTurn(), attackHero() and attackCard() methods are likely candidates).

Refactor your code base on feature branch "iteration4", and document it as outlined in the report template (link below in 'Deliveries' section.)

Ensure that you have no items on your backlog before submitting this week. That is, all functional requirements on AlphaStone, BetaStone, GammaStone, and DeltaStone must now be fulfilled by your implementation!

ZetaStone

Develop the ZetaStone variant using a compositional approach.

• Sketch a State pattern based design using UML for handling the ZetaStone requirement.
• Implement the ZetaStone variant using TDD.
• Document your design as outlined in the report template.

Deliveries:

• Document your clean code analysis and ZetaStone design by following the requirements defined in the iteration4 hand-in template (pdf) (LaTeX source). Links to the Clean Code template (excel, pdf) for documentation.
• Create one approximately 5-8 minutes long screencasts with audio narration that demonstrates a method clean up to achieve one or several clean code properties. The screencast must be structured with
  1. Intro: State your names and group name
  2. Short explanation of what clean code property that your method does NOT have, and outline what refactoring you will do to achieve it.
  3. Do the refactoring, explaining what you do as you go along.
  4. Conclude and argue how the code has become more clean.
  (Note: it is not a screen cast of the refactoring of the full method; it is like one of my screencasts in which I focus on one or a couple of clean code property and handle that.)

Evaluation criteria

Your submission is evaluated against the learning goals and adherence to the submission guidelines. The grading is explained in Grading Guidelines. The TAs will use the Iteration 4 Grade sheet to evaluate your submission.