ITECH 3201: Software Engineering: Analysis and Design
Assignment 1:
You are required to document, test and refactor an existing C# application, which is responsible for taking bookings for a theatre booking system. The current application this application is badly in need of refactoring and even a casual viewing of the source code reveals many examples of the “code smells” discussed by Fowler. Due Date: 30 April 2018
Weighting: 20%
Submission: via Moodle
Refer to Course Description, especially in regard to: Extensions, Special Consideration, Late Submissions, and Plagiarism.
Learning Outcome Assessed
The following course learning outcomes are assessed by completing this assessment:
i) Explain the significance of detailed project planning and control, good communication and documentation and the use of appropriate tools in order to provide a quality product
ii) Discriminate between software engineering and programming, and thus the distinction between a software configuration and a program
iii) Analyze source code and develop comprehensive unit test suites iv) Operate CASE software to document the design of a piece of software
v) Apply refactoring to identify poor programming practice in existing source code and improve its structure and readability
Introduction:
You are required to document, test and refactor an existing application. You will be given a copy of an existing C# application which is responsible for taking bookings for a theater, this application is badly in need of refactoring and even a casual viewing of the source code reveals many examples of the “code smells” discussed by Fowler.
Your report should be written in the same manner as Fowler has done in the prescribed text - small refactorings
(http://federation.edu.au/current-students/learning-and-study/online-help-with/guides-to-your-assessments) with code comparisons and UML diagrams (refer Fowler, M., & Beck, K. (2000). Refactoring : improving the design of existing code. Reading, MA: Addison-Wesley. pp. 1-65). Ask your tutor if you have any doubts.
Notes about the assignment
• Theatres have three sections: stalls, dress circle and balcony
• Each theatre section has a number of rows and each section row has the same number of seats.
• Each section has a different price per seat, Stalls $30.00, Dress circle $50.00, Balcony $90.00
• Customers must register with the system prior to placing a booking (Customers must present credit card information when registering)
• Customers may be members or nonmembers of the “Theatre Club”
o Non-members pay full price per seat
o Members fall into three categories: bronze, silver and gold. Bronze, Silver and Gold members are entitled to a discount of 10%, 20% and 30%, respectively off their booking.
• The system will automatically reserve a given number of seats in a requested section
o The seats are booked in the first row of a section which is found to have the number of requested seats free adjacent to each other.
o The application searches a section from the first row working backwards towards the last row until it finds the requested number of seats.
o There is no facility to book a particular seat.
• The system can potentially manage many theatres, each theatre has a number of theatre bookings (events) and each theatre booking has a number of customer bookings.
• Customers can currently only make a single booking for each event.
Requirements:
Report detailing any “code smells” present in the code and how you intend to refactor them out of the code
• A refactored version of the system eliminating all identified code smells
• A class diagram illustrating the initial code and another class diagram illustrating the final refactored code (including all relevant dependencies)
• Sequence Diagram: Calculation of Charges (represent the calls made by the refactored system when calculating the charges for a booking)
• Sequence Diagram: Booking Seats (represent the calls made by the refactored system when booking seats in response to a reservation)
• A sequence diagram illustrating how the final refactored system processes a new booking
• Extensive NUnit tests for the methods Calculation of Charges and Booking of Seats
• Add a loyalty rewards system. That theater is running a new promotion to include more members. If a Gold member includes his/her friend as the new member of the Theater, s/he (Gold member) will receive a further 15% in next booking. This numbers are 10% and 5% for silver and bronze members, respectively.
• The existing application doesn’t allow to book any particular seat. Include an appropriate method in your code base so that only the Gold members can book a particular seat. If that particular seats is not available, the user may try for more 2 time to select another seat. However, when all the chances are gone, that booking will be performed in usual system.
• Your report should identify any of Fowler’s “Bad Smells” in the code, and which refactorings you performed to improve the application’s design. Refactor the code using the textbook and the refactoring example from the lectures as a guide. The resultant code should be generally free from Fowler’s “code smells”, this will become obvious when you start writing your NUnit tests and documenting the refactored system in UML.
Submission:
You are required to submit to on Moodle before the due date in a zip file containing:
• A solution called final which has all of the final refactored code and the project for the unit tests
• The accompanying Enterprise Architect file with model versions of the original (that you started with) and final code projects.
• A word document containing your UML models and a justification of your refactorings.
Name your zip file as: yourstudentID_FirstName_LastName.zip
Marking Guide:
Task Mark
Report detailing any “code smells” present in the code, and how you intend to refactor them out of the application. Your report should be complete and follow the general guidelines for the presentation of academic work. The style of your report should be the same as that used by Fowler in his book ‘Refactoring’
[UML diagrams are awarded full marks if they correctly represent the system, a diagram which has errors but still communicates the system in a meaningful way receives half marks, all other diagrams receive zero marks] 3
Class diagram illustrating the initial code and another class diagram illustrating the final refactored code (including all relevant dependencies). 2
Sequence diagram: Calculation of Charges (represent the calls made by the refactored system when calculating the charges for a booking 2.5
Sequence Diagram: Booking Seats (represent the calls made by the refactored system when booking seats in response to a reservation) 2.5
The method that includes the loyalty promotion program. 2
The method that includes the extra feature on booking a particular seat booking. 2
A refactored version of the system eliminating all identified code smells present in the initial code. 3
Extensive NUnit tests for the complete refactored system. You must write an NUnit test for every public method (except for getters and setters) in your system 3
Total 20