Zaawansowane projektowanie obiektowe

Sposób oceniania

Wystąpienie przynajmniej jednego przykrego zapachu obniża ocenę o 1 stopień. Wystąpienie dwóch różnych przykrych zapachów obniża ocenę o 2 stopnie. Nie przestrzeganie standardu kodowania oraz/lub błędy w dokumentacji technicznej obniża o 0,5 stopnia. Program z niepełną listą refaktoryzacji może mieć obniżoną ocenę o 1-2 stopnie. Program, który nie działa prawidłowo ma obniżaną ocenę o 0,5 stopnia. Program, którego nie można skompilować nie będzie oceniany. Program bez listy przeprowadzonych metod refaktoryzacji i przypadków testowych nie będzie oceniany.

Standard kodowania

Obowiązuje standard kodowania Sun Microsystems http://java.sun.com/docs/codeconv/index.html

Nazewnictwo kodu

Obowiązuje język angielski. Pola i zmienne to rzeczowniki, metody to frazy czasownikowe:

Metody ustawiające (settery) to setXXX. Jesli ustawiana jest wartość typu boolean to nie przez argument a przez pare komplementarnych metod.
Przykład:
private boolean readonly = false; public void setReadOnly() { readOnly = true; } public void setReadWrite() { readOnly = false; }
Metody zwracajace wartosc to getXXX. Jesli zwracana jest wartość boolean to metoda powinna miec np. nazwę isReadOnly. Dla border="1"boolean jest tylko jedna metoda zwracająca wartość.
Metody boolean to isXXX hasXXXX etc.
Metody wyliczajace wartosc o istotnej zlozonosci obliczeniowej to calculateXXX
Metody dodajace do kolekcji to addXXX
Metody usuwajace to removeXXX

Przykre zapachy

Należy unikać następujących nieprawidłowych konstrukcji kodu.

Long Method (więcej informacji tutaj)

długie metody powyżej 20 LOC nie mieszczące się na ekranie
niezrozumiałe metody np. skomplikowane wyrażenia lepiej wyodrębnić do osobnej metody i dać im deskryptywną nazwę
metody o złożoności cyklomatycznej > 4

Data Class (więcej informacji tutaj)

pola publiczne
nieprawidłowa enkapsulacja kolekcji
struktury danych - brak innych metod niz get/set
metody get/set, które nie są nigdzie używane

Message Chains(więcej informacji tutaj)

Wywołanie wewnątrz metody badanej klasy metody, która nie jest metodą:

parametru badanej metody
badanego obiektu
statycznego obiektu
obiektu zwróconego przez którąś z metod badanego obiektu
pola badanego obiektu
elementu kolekcji; kolekcja jest polem w badanym obiekcie
obiektu utworzonego wewnątrz badanej metody

Middle Man (więcej informacji tutaj)

Feature Envy (więcej informacji tutaj)

Duplicated Code (więcej informacji tutaj)

Data Clumps (więcej informacji tutaj)

Long Parameter List (więcej informacji tutaj)

Speculative Generality (więcej informacji tutaj)

Dokumentacja techniczna do kodu

Kod należy opatrzyć komentarzami javadoc'a tak by można było z niego wygenerować dokumentację techniczną. Dokumentacja ma być w języku angielskim. Dokumentacja techniczna musi spełniać poniższe wymagania:

musi występować autor(zy) dla każdej klasy (@author)
muszą występować opisy do wszystkich wyrzucanych przez metodę wyjątków (@exception)
muszą występować opisy wszystkich argumentów (@param)
muszą występować opisy wartości zwracanych (@return)
nie opisujcie metod typu getter/setter oraz innych metod, których nazwy parametrów i metod w oczywisty sposób mówia o ich przeznaczeniu
jesli metoda zwraca kolekcje elementów to w tagu @return podajcie jakie to są obiekty np. obiekty typu String

Zadanie

Metoda statement w klasie Customer zwraca łańcuch znaków reprezentujący konto klienta wypożyczalni filmów.

W klasie Customer należy dodać metodę public String htmlStatement(), która zwróci łańcuch html reprezentujący statement klienta wypożyczalni. Metodę tą należy także wyposażyć w testy.

Format html:
<html><head><title>Rental Record for ${name}</title><body> <table><thead><tr><td>Title</td><td>Amount</td></tr> </thead> <tbody><tr><td>${title}</td><td>${amount}</td></tr> </tbody></table></body></html>

Nie wolno utworzyć tej metody przez copy - paste programming (duplikaty) :) Należy wyodrębnić wspólny kod z metody statement a następnie wykorzystać go ponownie w htmlStatement. W tym celu należy wykorzystać przekształcenia refaktoryzacyjne poznane na wykładzie oraz Split Loop Pamiętajcie też o usunięciu przykrych zapachów. Wyjątkiem jest tutaj klasa Movie, która ma pozostać Data Class. Kod: Customer.java, Movie.java, Rental.java, CustomerTest.java

Do oceny należy przedstawić kody źródłowe klas, testy oraz listę dokonanych refaktoryzacji wraz z krótkim opisem po co je wykonano (w javadoc'u). Oto przykład:
Move Method - Customer.getAmount do Rental