COMP 304B Object-Oriented Software Design - Assignment 6
  Due date: Wednesday April 11th, 2007 before 23:55

Practical information

• Due date: April 11th
• Team size == 2
• Your submission must be in the form of a simple HTML file (index.html) with explicit references to all submitted files as well as inline inclusion of images. See the general assignments page for an index.html template.
• Each team submits only one full solution. The other team member must submit a single index.html file containing only the coordinates of both team members. This will allow us to put in grades for both team members in WebCT.
• The submission medium is WebCT.
• To get insight into the assignment workload, provide the number of hours you spent on this assignment.

The assignment

In this assignment, you will implement Ultimate Sudoku, a Sudoku game that uses the Observer Pattern. You'll find that many of the other design patterns (such as Command) will make the implementation much easier and most elegant.

Ultimate Sudoku functions as follows: When a game starts, you are presented with a 9x9 Sudoku board and a control panel. The control panel allows you to open up new specific views of the Sudoku board. These views allow a player to focus on a particular area of the board. Players can enter their solution using the main Sudoku board, or any of the sub views. When a new value is entered, all the appropriate views are updated. This means data is stored in a central location to which views are attached. Note that when the board is updated, only the affected views should be updated.

Ultimate Sudoku also features two undo functionalities. The first, "undo last move", allows a player to undo his last move. Pressing the button again further reverse the board by undoing the move before. This functionality is very useful given that players might be solving the board using multiple windows. The second, "undo since error", will allow a player to undo moves if he has committed an error. For example, a player erroneously enters the value 4 in the square 3,3. He then continues to do 10 other moves until he discovers that he made a mistake. By pressing the "undo since error" button, the game will roll back to the state it was before entering the value 4 in 3,3. This will be achieved by undoing the 11 last moves.

Your implementation of Ultimate Sudoku should contain at least 1 Sudoku puzzle. To properly support the undo functions and the end game, you will also need to know the solution to the puzzle. Your first implementation can simply load these information from a text file. However, you might to further improve this system.

When a player successfully solves a Sudoku board, the game should inform the player and allow him to play again.

UML

Before implementing your solution, I want you to draw two UML diagrams:

1. A Class Diagram of your solution. This diagram should include all components of your solution, including your GUI classes. Of course, you don't need to draw classes from libraries, such a Tkinter.
3. A Sequence Diagram of what happens when a player enters a new value in the main grid. This should include the updating of your data structure and the notification of the views.

Implementation

Your Sudoku game must be implemented in Python. A simple GUI for this assignment is available here.

Handin

You should hand in the following:

• An index file with your documentation and running instructions, as usual.
• Your UML diagrams.
• Your Sudoku application.

Grading

Correctly implementing the following minimal features will allow to obtain of approximately 70% :

• You can play at least 1 Sudoku board.
• The game properly terminates when the correct solution is entered.
• The display windows are implemented using the observer patterns.
• You can properly undo your last move.
• You can properly undo all the last moves since an erroneous value was entered.
• Only one copy of the main board can be created.
• You have drawn all the required UML diagrams.

Correctly implementing the following additional features will allow you to obtain a maximum grade of 85%.

• Your game supports at least 5 different Sudoku boards.
• The corrector is unable to crash your game.
• You have implemented Unit testing of at least 1 class (about 6 test functions) using PyUnit.
• Your code nicely separates game logic from GUI code.

To have a grade of a 100%, you must correctly implement all of the previous features, plus a couple from the following list.

• Your game randomly generates (and solves) Sudoku boards. (You can probably find code on the Net for this. Just don't forget to quote your source.)
• You can save/resume Sudoku games.
• All your classes (or almost) are tested using PyUnit.
• You have written a new GUI, and it's much nicer than mine (but it retains all the functionalities of the previous GUI).
• Your game has a high score system.
• Any other cool feature you've discussed with me before.

Note: One of your Sudoku puzzles should be easy enough, so the grader can complete it and test the win condition (cheat mode?).