Упражнение: разхвърлян клас, изчистен стъпка по стъпка

Код на:JavaC#PythonJavaScript

Накратко: Упражнение по refactoring: клас за наем на тротинетки се изчиства на пет малки стъпки (имена, магически числа, пари, въпрос отделно от командата, планове), а тестовете остават зелени.

Проблем

Тротинетките, които никой не смее да пипне

Фирма за тротинетки под наем таксува всяко возене с класа RideMgr. Работи от три години. Методът calc смята цената по плана на клиента (на минута, студент или месечна карта), маха таксата за отключване от четвъртото возене за деня, слага нощна добавка, трупа оборота и праща бележка:

class RideMgr {
    private final Map<String, Integer> c = new HashMap<>();
    private double s = 0;
    private final List<String> out = new ArrayList<>();

    // Цената: 1 € за отключване и 0,15 € на минута.
    // Нощем цената се вдига с 50%.
    public double calc(String to, String t, int m, boolean f) {
        c.put(to, c.getOrDefault(to, 0) + 1);
        double p = 0;
        if (t.equals("payg")) {
            p = 1.0 + m * 0.2;
        } else if (t.equals("student")) {
            p = (1.0 + m * 0.2) * 0.8;
        } else if (t.equals("monthly")) {
            if (m > 45) {
                p = (m - 45) * 0.2;
            }
        }
        if (c.get(to) > 3 && !t.equals("monthly")) {
            p = p - 1.0;
        }
        if (f) {
            p = p + 0.5;
        }
        s = s + p;
        out.add(to + ": " + m + " мин, " + String.format("%.2f", p) + " €");
        return p;
    }

    public List<String> sent() {
        return out;
    }

    public double day() {
        return s;
    }
}

Следващия месец идват две промени:

• фирмен план: без такса за отключване, 0,18 € на минута, без отстъпка за четвъртото возене;
• цената преди края: приложението показва колко ще струва возенето, докато то още тече.

Втората не става с този клас. Ето какво се случва, ако приложението извика calc, за да покаже цената, и после пак, за да вземе парите:

RideMgr rides = new RideMgr();
double shown = rides.calc("ana@example.com", "payg", 10, false);
System.out.println("Цена преди края: " + String.format("%.2f €", shown));
double charged = rides.calc("ana@example.com", "payg", 10, false);
System.out.println("Взето: " + String.format("%.2f €", charged));
System.out.println("Бележки: " + rides.sent().size());
System.out.println("Оборот: " + String.format("%.2f €", rides.day()));

Изход

Цена преди края: 3.00 €
Взето: 3.00 €
Бележки: 2
Оборот: 6.00 €

Едно возене, две бележки и 6 € оборот. calc звучи като въпрос, а брои, трупа и праща.

В урока няма нова идея. Той е упражнение: класът минава през инструментите от модула един по един, на малки стъпки, а след всяка стъпка пускаш тестовете.

Виж го

Стъпка 0: мрежата

Първо мрежата, както в урока за тестовете. Девет теста заковават какво прави класът днес: цената по всеки план, нощта, четвъртото возене, бележката и оборота.

import java.util.List;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

class RideMgrTest {
    static final String EMAIL = "ana@example.com";

    RideMgr rides = new RideMgr();

    String ride(String plan, int minutes, boolean night) {
        return money(rides.calc(EMAIL, plan, minutes, night));
    }

    String money(double amount) {
        return String.format("%.2f", amount);
    }

    @Test
    void payAsYouGoRide() {
        assertEquals("3.00", ride("payg", 10, false));
    }

    @Test
    void studentRide() {
        assertEquals("2.40", ride("student", 10, false));
    }

    @Test
    void monthlyWithinFreeMinutes() {
        assertEquals("0.00", ride("monthly", 30, false));
    }

    @Test
    void monthlyOverFreeMinutes() {
        assertEquals("3.00", ride("monthly", 60, false));
    }

    @Test
    void nightSurcharge() {
        assertEquals("3.50", ride("payg", 10, true));
    }

    @Test
    void fourthRideUnlockIsFree() {
        ride("payg", 10, false);
        ride("payg", 10, false);
        ride("payg", 10, false);
        assertEquals("2.00", ride("payg", 10, false));
    }

    @Test
    void studentFourthRide() {
        // Така е днес: отстъпката е целият 1 €, а не 0,80 €.
        ride("student", 10, false);
        ride("student", 10, false);
        ride("student", 10, false);
        assertEquals("1.40", ride("student", 10, false));
    }

    @Test
    void receipt() {
        ride("payg", 10, false);
        assertEquals(List.of("ana@example.com: 10 мин, 3.00 €"), rides.sent());
    }

    @Test
    void revenue() {
        ride("payg", 10, false);
        ride("student", 10, false);
        assertEquals("5.40", money(rides.day()));
    }
}

Резултат

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Тестовете викат класа само през помощника ride. Когато в следващите стъпки формата на класа се смени, ще се сменят той и извикванията, а очакваните стойности никога.

Единият тест е странен. Студентът плаща 80% от цената, значи и отключването му струва 0,80 €. На четвъртото возене обаче класът маха целия 1 €, и студентът плаща 1,40 € вместо 1,60 €. Грешка ли е, или подарък? Не решаваш ти и не решаваш сега. Тестът заковава какво е днес, с коментар, а въпросът отива при собственика на продукта. Докато чистиш, поведението не се сменя, дори когато изглежда грешно.

По-точно, за любопитните

Сумите се сравняват като текст с две цифри ("2.40"), както ги вижда клиентът. Сравнение с число щеше да се препъне в малките двоични грешки на double:

System.out.println((1.0 + 10 * 0.2) * 0.8);

Изход

2.4000000000000004

А в стъпка 3 типът на сумите ще се смени. Текстът с две цифри е един и същ преди и след.

Виж го

Стъпка 1: имената и флагът

t, m, f, p, c и s стават думи (имената). Най-важното име е на метода: той не смята, а приключва возенето. Честното име е finishRide, и страничният ефект вече се вижда от името. Класът става RideBilling.

class RideBilling {
    private final Map<String, Integer> ridesToday = new HashMap<>();
    private double revenue = 0;
    private final List<String> receipts = new ArrayList<>();

    // Цената: 1 € за отключване и 0,15 € на минута.
    // Нощем цената се вдига с 50%.
    public double finishRide(String email, String plan, int minutes, boolean night) {
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        double price = 0;
        if (plan.equals("payg")) {
            price = 1.0 + minutes * 0.2;
        } else if (plan.equals("student")) {
            price = (1.0 + minutes * 0.2) * 0.8;
        } else if (plan.equals("monthly")) {
            if (minutes > 45) {
                price = (minutes - 45) * 0.2;
            }
        }
        if (ridesToday.get(email) > 3 && !plan.equals("monthly")) {
            price = price - 1.0;
        }
        if (night) {
            price = price + 0.5;
        }
        revenue = revenue + price;
        receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
        return price;
    }

    public List<String> receipts() {
        return receipts;
    }

    public double revenue() {
        return revenue;
    }
}

Остава флагът (функциите). true при извикването не казва нищо. Нощта е данни за возенето, а не избор на друга работа, затова не става две функции. Извикването трябва да казва какво значи:

Java няма аргументи по име. В тестовете стойностите са константи с имена, DAY и NIGHT, а помощникът ги подава нататък.

Преди

String ride(String plan, int minutes, boolean night) {
    return money(rides.calc(EMAIL, plan, minutes, night));
}

@Test
void nightSurcharge() {
    assertEquals("3.50", ride("payg", 10, true));
}

След

static final boolean DAY = false;
static final boolean NIGHT = true;

String ride(String plan, int minutes, boolean night) {
    return money(billing.finishRide(EMAIL, plan, minutes, night));
}

@Test
void nightSurcharge() {
    assertEquals("3.50", ride("payg", 10, NIGHT));
}

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

В IntelliJ IDEA преименуването е Shift+F6: сменя и извикванията в тестовете.

Виж го

Стъпка 2: числата и коментарът, който лъже

1.0, 0.2, 0.8, 45, 3 и 0.5 стават константи с имена (магическо число → константа).

Коментарът над метода казва 0,15 € на минута и 50% нощна надценка. Кодът взима 0,20 € и добавя 0,50 €. Кое е вярно? Тестовете заковаха какво прави кодът, а клиентите плащат по него от години. Коментарът лъже (коментарите) и се трие. Константите казват същото и не могат да остареят отделно от кода.

class RideBilling {
    private static final double UNLOCK_FEE = 1.00;
    private static final double PER_MINUTE = 0.20;
    private static final double STUDENT_SHARE = 0.80;
    private static final int MONTHLY_FREE_MINUTES = 45;
    private static final int PAID_UNLOCKS_PER_DAY = 3;
    private static final double NIGHT_SURCHARGE = 0.50;

    private final Map<String, Integer> ridesToday = new HashMap<>();
    private double revenue = 0;
    private final List<String> receipts = new ArrayList<>();

    public double finishRide(String email, String plan, int minutes, boolean night) {
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        double price = 0;
        if (plan.equals("payg")) {
            price = UNLOCK_FEE + minutes * PER_MINUTE;
        } else if (plan.equals("student")) {
            price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE;
        } else if (plan.equals("monthly")) {
            if (minutes > MONTHLY_FREE_MINUTES) {
                price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE;
            }
        }
        if (ridesToday.get(email) > PAID_UNLOCKS_PER_DAY && !plan.equals("monthly")) {
            price = price - UNLOCK_FEE;
        }
        if (night) {
            price = price + NIGHT_SURCHARGE;
        }
        revenue = revenue + price;
        receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
        return price;
    }

    public List<String> receipts() {
        return receipts;
    }

    public double revenue() {
        return revenue;
    }
}

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Тестовете не се пипат: нито името, нито извикванията са се сменили.

Пробвай

Намери грешката

Колега прави същата стъпка, но вярва на коментара и го оставя:

Избери реда с грешката.

1// Цената: 1 € за отключване и 0,15 € на минута.2// Нощем цената се вдига с 50%.3private static final double UNLOCK_FEE = 1.00;4private static final double PER_MINUTE = 0.15;5private static final double STUDENT_SHARE = 0.80;6private static final int MONTHLY_FREE_MINUTES = 45;7private static final int PAID_UNLOCKS_PER_DAY = 3;8private static final double NIGHT_SURCHARGE = 0.50;

Провери

По-точно, за любопитните

Тестовете

ОК    monthlyWithinFreeMinutes()
ПАДА  fourthRideUnlockIsFree()
ПАДА  monthlyOverFreeMinutes()
ПАДА  nightSurcharge()
ПАДА  payAsYouGoRide()
ПАДА  receipt()
ПАДА  revenue()
ПАДА  studentFourthRide()
ПАДА  studentRide()
Тестове: 9, минали: 1, паднали: 8

Виж го

Стъпка 3: парите

Парите в double са примитиви вместо типове (миризмите). Днес това не дава грешен цент в нито един тест, защото всяка сума се закръгля чак при печатане. Затова стъпката е refactoring: изходът е същият. Но оборотът е сбор от хиляди такива суми, и там малките грешки се трупат.

double става BigDecimal, създаден от низ. BigDecimal няма оператори: + и * стават add и multiply. Повтореното PER_MINUTE.multiply(BigDecimal.valueOf(minutes)) става малък метод perMinute.

class RideBilling {
    private static final BigDecimal UNLOCK_FEE = new BigDecimal("1.00");
    private static final BigDecimal PER_MINUTE = new BigDecimal("0.20");
    private static final BigDecimal STUDENT_SHARE = new BigDecimal("0.80");
    private static final int MONTHLY_FREE_MINUTES = 45;
    private static final int PAID_UNLOCKS_PER_DAY = 3;
    private static final BigDecimal NIGHT_SURCHARGE = new BigDecimal("0.50");

    private final Map<String, Integer> ridesToday = new HashMap<>();
    private BigDecimal revenue = BigDecimal.ZERO;
    private final List<String> receipts = new ArrayList<>();

    private static BigDecimal perMinute(int minutes) {
        return PER_MINUTE.multiply(BigDecimal.valueOf(minutes));
    }

    public BigDecimal finishRide(String email, String plan, int minutes, boolean night) {
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        BigDecimal price = BigDecimal.ZERO;
        if (plan.equals("payg")) {
            price = UNLOCK_FEE.add(perMinute(minutes));
        } else if (plan.equals("student")) {
            price = UNLOCK_FEE.add(perMinute(minutes)).multiply(STUDENT_SHARE);
        } else if (plan.equals("monthly")) {
            if (minutes > MONTHLY_FREE_MINUTES) {
                price = perMinute(minutes - MONTHLY_FREE_MINUTES);
            }
        }
        if (ridesToday.get(email) > PAID_UNLOCKS_PER_DAY && !plan.equals("monthly")) {
            price = price.subtract(UNLOCK_FEE);
        }
        if (night) {
            price = price.add(NIGHT_SURCHARGE);
        }
        revenue = revenue.add(price);
        receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
        return price;
    }

    public List<String> receipts() {
        return receipts;
    }

    public BigDecimal revenue() {
        return revenue;
    }
}

В тестовете се сменя само помощникът, който превръща сумата в текст:

String money(BigDecimal amount) {
    return String.format("%.2f", amount);
}

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Пробвай

Попълни

Цената на минута в типа за пари на езика:

private static final BigDecimal PER_MINUTE = new BigDecimal();

Провери

Виж го

Стъпка 4: въпросът отделно от командата

Сега промяната, която чакаше: цената преди края трябва да е въпрос, който не сменя нищо (команда или въпрос). Изчисляването се изважда в метод price (Extract Method от урока за refactoring). finishRide остава команда: пита за цената, после брои, трупа и праща.

Колега го прави така. Броячът отива след цената, защото возенето се брои, когато е приключило:

Какво казват деветте теста?

public BigDecimal price(String email, String plan, int minutes, boolean night) {
    BigDecimal price = BigDecimal.ZERO;
    if (plan.equals("payg")) {
        price = UNLOCK_FEE.add(perMinute(minutes));
    } else if (plan.equals("student")) {
        price = UNLOCK_FEE.add(perMinute(minutes)).multiply(STUDENT_SHARE);
    } else if (plan.equals("monthly")) {
        if (minutes > MONTHLY_FREE_MINUTES) {
            price = perMinute(minutes - MONTHLY_FREE_MINUTES);
        }
    }
    if (ridesToday.getOrDefault(email, 0) > PAID_UNLOCKS_PER_DAY && !plan.equals("monthly")) {
        price = price.subtract(UNLOCK_FEE);
    }
    if (night) {
        price = price.add(NIGHT_SURCHARGE);
    }
    return price;
}

public BigDecimal finishRide(String email, String plan, int minutes, boolean night) {
    BigDecimal price = price(email, plan, minutes, night);
    ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
    revenue = revenue.add(price);
    receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
    return price;
}

Отговор

Пада само fourthRideUnlockIsFree()

Падат fourthRideUnlockIsFree() и studentFourthRide()

Минават и деветте: броячът е същият, само е на друго място

Провери

По-точно, за любопитните

Тестовете

ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentRide()
ПАДА  fourthRideUnlockIsFree(): expected: <2.00> but was: <3.00>
ПАДА  studentFourthRide(): expected: <1.40> but was: <2.40>
Тестове: 9, минали: 7, паднали: 2

Виж го

Стъпка 4, втори опит

Червеното сочи последната стъпка. Не търсиш грешката в целия клас: връщаш стъпката и я правиш пак. Редът на страничните ефекти беше скрита част от поведението, и знаеха за нея само тестовете.

price смята кое поред ще е возенето:

public BigDecimal price(String email, String plan, int minutes, boolean night) {
    int rideOfDay = ridesToday.getOrDefault(email, 0) + 1;
    BigDecimal price = BigDecimal.ZERO;
    if (plan.equals("payg")) {
        price = UNLOCK_FEE.add(perMinute(minutes));
    } else if (plan.equals("student")) {
        price = UNLOCK_FEE.add(perMinute(minutes)).multiply(STUDENT_SHARE);
    } else if (plan.equals("monthly")) {
        if (minutes > MONTHLY_FREE_MINUTES) {
            price = perMinute(minutes - MONTHLY_FREE_MINUTES);
        }
    }
    if (rideOfDay > PAID_UNLOCKS_PER_DAY && !plan.equals("monthly")) {
        price = price.subtract(UNLOCK_FEE);
    }
    if (night) {
        price = price.add(NIGHT_SURCHARGE);
    }
    return price;
}

public BigDecimal finishRide(String email, String plan, int minutes, boolean night) {
    BigDecimal price = price(email, plan, minutes, night);
    ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
    revenue = revenue.add(price);
    receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
    return price;
}

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Тестовете пак не се пипат: те викат finishRide, а то прави същото като преди.

Целият клас след стъпка 4

class RideBilling {
    private static final BigDecimal UNLOCK_FEE = new BigDecimal("1.00");
    private static final BigDecimal PER_MINUTE = new BigDecimal("0.20");
    private static final BigDecimal STUDENT_SHARE = new BigDecimal("0.80");
    private static final int MONTHLY_FREE_MINUTES = 45;
    private static final int PAID_UNLOCKS_PER_DAY = 3;
    private static final BigDecimal NIGHT_SURCHARGE = new BigDecimal("0.50");

    private final Map<String, Integer> ridesToday = new HashMap<>();
    private BigDecimal revenue = BigDecimal.ZERO;
    private final List<String> receipts = new ArrayList<>();

    private static BigDecimal perMinute(int minutes) {
        return PER_MINUTE.multiply(BigDecimal.valueOf(minutes));
    }

    public BigDecimal price(String email, String plan, int minutes, boolean night) {
        int rideOfDay = ridesToday.getOrDefault(email, 0) + 1;
        BigDecimal price = BigDecimal.ZERO;
        if (plan.equals("payg")) {
            price = UNLOCK_FEE.add(perMinute(minutes));
        } else if (plan.equals("student")) {
            price = UNLOCK_FEE.add(perMinute(minutes)).multiply(STUDENT_SHARE);
        } else if (plan.equals("monthly")) {
            if (minutes > MONTHLY_FREE_MINUTES) {
                price = perMinute(minutes - MONTHLY_FREE_MINUTES);
            }
        }
        if (rideOfDay > PAID_UNLOCKS_PER_DAY && !plan.equals("monthly")) {
            price = price.subtract(UNLOCK_FEE);
        }
        if (night) {
            price = price.add(NIGHT_SURCHARGE);
        }
        return price;
    }

    public BigDecimal finishRide(String email, String plan, int minutes, boolean night) {
        BigDecimal price = price(email, plan, minutes, night);
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        revenue = revenue.add(price);
        receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
        return price;
    }

    public List<String> receipts() {
        return receipts;
    }

    public BigDecimal revenue() {
        return revenue;
    }
}

Виж го

Стъпка 5: плановете

Остава веригата от if по текста на плана (дълга верига от if). Всеки нов план е нов клон, а "monthly" се проверява на две места. Всеки план става клас, който знае цената си и отстъпката за четвъртото возене. Това е Replace Conditional with Polymorphism от урока за refactoring:

interface Plan {
    BigDecimal price(int minutes);

    BigDecimal loyaltyDiscount();
}

class PayAsYouGo implements Plan {
    @Override
    public BigDecimal price(int minutes) {
        return RideBilling.UNLOCK_FEE.add(RideBilling.perMinute(minutes));
    }

    @Override
    public BigDecimal loyaltyDiscount() {
        return RideBilling.UNLOCK_FEE;
    }
}

class Student implements Plan {
    private static final BigDecimal STUDENT_SHARE = new BigDecimal("0.80");

    @Override
    public BigDecimal price(int minutes) {
        return new PayAsYouGo().price(minutes).multiply(STUDENT_SHARE);
    }

    @Override
    public BigDecimal loyaltyDiscount() {
        // Така е днес: целият 1 €, макар че отключването на студента струва 0,80 €.
        return RideBilling.UNLOCK_FEE;
    }
}

class Monthly implements Plan {
    private static final int FREE_MINUTES = 45;

    @Override
    public BigDecimal price(int minutes) {
        return RideBilling.perMinute(Math.max(0, minutes - FREE_MINUTES));
    }

    @Override
    public BigDecimal loyaltyDiscount() {
        return BigDecimal.ZERO;
    }
}

Проверката за месечната карта изчезва: тя просто връща 0 отстъпка. Странното поведение на студента вече е на един ред, с коментар, който казва защо е така (добрият коментар от урока за коментарите).

class RideBilling {
    static final BigDecimal UNLOCK_FEE = new BigDecimal("1.00");
    static final BigDecimal PER_MINUTE = new BigDecimal("0.20");
    private static final int PAID_UNLOCKS_PER_DAY = 3;
    private static final BigDecimal NIGHT_SURCHARGE = new BigDecimal("0.50");

    private final Map<String, Integer> ridesToday = new HashMap<>();
    private BigDecimal revenue = BigDecimal.ZERO;
    private final List<String> receipts = new ArrayList<>();

    static BigDecimal perMinute(int minutes) {
        return PER_MINUTE.multiply(BigDecimal.valueOf(minutes));
    }

    public BigDecimal price(String email, Plan plan, int minutes, boolean night) {
        int rideOfDay = ridesToday.getOrDefault(email, 0) + 1;
        BigDecimal price = plan.price(minutes);
        if (rideOfDay > PAID_UNLOCKS_PER_DAY) {
            price = price.subtract(plan.loyaltyDiscount());
        }
        if (night) {
            price = price.add(NIGHT_SURCHARGE);
        }
        return price;
    }

    public BigDecimal finishRide(String email, Plan plan, int minutes, boolean night) {
        BigDecimal price = price(email, plan, minutes, night);
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        revenue = revenue.add(price);
        receipts.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
        return price;
    }

    public List<String> receipts() {
        return receipts;
    }

    public BigDecimal revenue() {
        return revenue;
    }
}

Делът на студента и безплатните минути отиват в плана, който ги ползва. Таксата за отключване и цената на минута са общи за няколко плана, затова остават в класа за таксуването и вече не са private.

В тестовете извикванията подават обект вместо текст:

assertEquals("3.50", ride("payg", 10, NIGHT));
assertEquals("3.50", ride(new PayAsYouGo(), 10, NIGHT));

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Това е Strategy от модула за шаблоните: правилото е отделен обект, а таксуването само пита.

Виж го

Двете промени сега

Фирменият план е нов клас. Класът за таксуването не се пипа (отворено за разширение):

class Business implements Plan {
    private static final BigDecimal PER_MINUTE = new BigDecimal("0.18");

    @Override
    public BigDecimal price(int minutes) {
        return PER_MINUTE.multiply(BigDecimal.valueOf(minutes));
    }

    @Override
    public BigDecimal loyaltyDiscount() {
        return BigDecimal.ZERO;
    }
}

Цената преди края е въпросът price. Колкото пъти и да го викаш, нищо не се брои и не тръгва бележка:

public class Main {
    static final boolean DAY = false;
    static final boolean NIGHT = true;

    public static void main(String[] args) {
        RideBilling billing = new RideBilling();
        Plan payg = new PayAsYouGo();
        billing.finishRide("ana@example.com", payg, 10, DAY);
        billing.finishRide("ana@example.com", payg, 5, DAY);
        billing.finishRide("ana@example.com", payg, 12, NIGHT);
        System.out.println("Цена преди края: " + String.format("%.2f €", billing.price("ana@example.com", payg, 8, DAY)));
        System.out.println("Цена преди края: " + String.format("%.2f €", billing.price("ana@example.com", payg, 8, DAY)));
        System.out.println("Взето: " + String.format("%.2f €", billing.finishRide("ana@example.com", payg, 8, DAY)));
        System.out.println("Фирмата, 12 мин: " + String.format("%.2f €", billing.finishRide("office@example.com", new Business(), 12, DAY)));
        System.out.println("Бележки: " + billing.receipts().size());
    }
}

Изход

Цена преди края: 1.60 €
Цена преди края: 1.60 €
Взето: 1.60 €
Фирмата, 12 мин: 2.16 €
Бележки: 5

Пет бележки: три возения преди прегледа, четвъртото и това на фирмата. Двата прегледа не оставят следа, а показват точно колкото после се взима.

Идеята

Преди и след

Миризма	Стъпка	Урок
нищо не пази поведението	0: тестове, които заковават днешното	мрежата
имена от една буква, calc, който не казва, че праща	1: Rename	имената
true при извикването	1: аргумент, който казва какво значи	функциите
магически числа	2: константи с имена	имената
коментар, който лъже	2: изтрит	коментарите
пари в double	3: тип за пари	миризмите
въпрос със скрит страничен ефект, дълъг метод	4: Extract Method, команда и въпрос	функциите, refactoring
верига от if по плана като текст	5: Replace Conditional with Polymorphism	миризмите, refactoring, SOLID

Класът стана по-дълъг, не по-къс. Но всяко правило е на едно място и с име, а промените от началото са по един клас.

Денят на возенията, пуснат с класа отпреди стъпка 1 и с класа след стъпка 5, печата едно и също ред по ред. Тук и двете програми се пускат при всяка проверка на сайта.

Преди

RideMgr rides = new RideMgr();
rides.calc("ana@example.com", "payg", 10, false);
rides.calc("ivan@example.com", "student", 25, false);
rides.calc("ana@example.com", "payg", 5, false);
rides.calc("maria@example.com", "monthly", 60, true);
rides.calc("ana@example.com", "payg", 12, true);
rides.calc("ana@example.com", "payg", 8, false);

for (String receipt : rides.sent()) {
    System.out.println(receipt);
}
System.out.println("Оборот: " + String.format("%.2f €", rides.day()));

След

public class Main {
    static final boolean DAY = false;
    static final boolean NIGHT = true;

    public static void main(String[] args) {
        RideBilling billing = new RideBilling();
        Plan payg = new PayAsYouGo();
        billing.finishRide("ana@example.com", payg, 10, DAY);
        billing.finishRide("ivan@example.com", new Student(), 25, DAY);
        billing.finishRide("ana@example.com", payg, 5, DAY);
        billing.finishRide("maria@example.com", new Monthly(), 60, NIGHT);
        billing.finishRide("ana@example.com", payg, 12, NIGHT);
        billing.finishRide("ana@example.com", payg, 8, DAY);

        for (String receipt : billing.receipts()) {
            System.out.println(receipt);
        }
        System.out.println("Оборот: " + String.format("%.2f €", billing.revenue()));
    }
}

Изход

ana@example.com: 10 мин, 3.00 €
ivan@example.com: 25 мин, 4.80 €
ana@example.com: 5 мин, 2.00 €
maria@example.com: 60 мин, 3.50 €
ana@example.com: 12 мин, 3.90 €
ana@example.com: 8 мин, 1.60 €
Оборот: 18.80 €

Идеята

Къде да спреш

Спираш, когато промените, които идват, станат лесни. Тук двете промени са един клас и един ред. Затова някои стъпки съзнателно не са направени:

• бележката в свой клас. Текстът на бележката е втора причина класът да се сменя (една причина за промяна). Днес той не се сменя. Щом маркетингът започне да го пипа всеки месец, става отделен клас (задача 1);
• изпращането зад интерфейс. Бележките са списък, а не истински имейл. Когато дойде истинският имейл, тестът не бива да го праща, и тогава идва абстракцията (зависимост от абстракция);
• поведението на студента. То е промяна в поведението, не изчистване. Прави се отделно, със свой тест, когато продуктът реши.

И правилото от урока за refactoring: или сменяш формата, или поведението, никога и двете в една стъпка.

Упражнение

Продължи сам

Реши задачите в редактора си, като тръгнеш от класа след стъпка 5. След всяка стъпка пусни деветте теста.

1. Бележката в свой клас. Изнеси текста на бележката и списъка с изпратените в клас ReceiptBook. Класът за таксуването само му казва „изпрати“. Тестовете не се пипат.

Едно възможно решение

class ReceiptBook {
    private final List<String> sent = new ArrayList<>();

    public void send(String email, int minutes, BigDecimal price) {
        sent.add(email + ": " + minutes + " мин, " + String.format("%.2f", price) + " €");
    }

    public List<String> sent() {
        return sent;
    }
}

class RideBilling {
    static final BigDecimal UNLOCK_FEE = new BigDecimal("1.00");
    static final BigDecimal PER_MINUTE = new BigDecimal("0.20");
    private static final int PAID_UNLOCKS_PER_DAY = 3;
    private static final BigDecimal NIGHT_SURCHARGE = new BigDecimal("0.50");

    private final Map<String, Integer> ridesToday = new HashMap<>();
    private BigDecimal revenue = BigDecimal.ZERO;
    private final ReceiptBook receipts = new ReceiptBook();

    static BigDecimal perMinute(int minutes) {
        return PER_MINUTE.multiply(BigDecimal.valueOf(minutes));
    }

    public BigDecimal price(String email, Plan plan, int minutes, boolean night) {
        int rideOfDay = ridesToday.getOrDefault(email, 0) + 1;
        BigDecimal price = plan.price(minutes);
        if (rideOfDay > PAID_UNLOCKS_PER_DAY) {
            price = price.subtract(plan.loyaltyDiscount());
        }
        if (night) {
            price = price.add(NIGHT_SURCHARGE);
        }
        return price;
    }

    public BigDecimal finishRide(String email, Plan plan, int minutes, boolean night) {
        BigDecimal price = price(email, plan, minutes, night);
        ridesToday.put(email, ridesToday.getOrDefault(email, 0) + 1);
        revenue = revenue.add(price);
        receipts.send(email, minutes, price);
        return price;
    }

    public List<String> receipts() {
        return receipts.sent();
    }

    public BigDecimal revenue() {
        return revenue;
    }
}

Тестовете

ОК    fourthRideUnlockIsFree()
ОК    monthlyOverFreeMinutes()
ОК    monthlyWithinFreeMinutes()
ОК    nightSurcharge()
ОК    payAsYouGoRide()
ОК    receipt()
ОК    revenue()
ОК    studentFourthRide()
ОК    studentRide()
Тестове: 9, минали: 9, паднали: 0

Програмата за деня от картата „Преди и след“ печата с този клас същия изход.

2. Планът от текста. Планът идва от базата като текст ("payg"). Напиши таблицата, която го превръща в обект. Какво правеше старият клас с непознат план? Закови го с тест върху стария клас, преди да решиш какво да прави новият.

3. Нощта от часа. Приложението вече не знае кога е нощ, а подава времето на тръгване. Правилото „от 22:00 до 6:00“ трябва да живее на едно място. Напиши първо тестовете за 21:59, 22:00, 5:59 и 6:00.

4. Студентът. Продуктът реши: на четвъртото возене студентът получава 0,80 €, а не 1 €. Това е промяна в поведението: първо смени очакваното в теста и го виж червен, после смени един ред в плана.

Тест

Провери се

1. Тестът за студента на четвъртото возене очаква 1.40 €, а „правилното“ изглежда 1.60 €. Какво правиш, докато чистиш класа?

Изтриваш теста, защото заковава грешкаОставяш теста както е, с коментар, и питаш собственика на продукта. Ако реши друго, това е отделна промяна със свой тестСменяш очакваното на 1.60 и поправяш кода в същата стъпка

2. Коментарът казва 0,15 € на минута, а кодът взима 0,20 €. На кое вярваш?

На кода: тестовете заковаха какво прави той, и клиентите плащат по него от годиниНа коментара: той е документациятаНа по-новото от двете

3. Защо тестовете викат класа през един помощник, а не директно?

Когато формата на класа се смени, се сменя едно място, а очакваните стойности остават същитеТака са по-бързиЗащото рамката за тестове го изисква

4. Първият опит за стъпка 4 направи два теста червени. Какво правиш?

Сменяш очакваното в двата тестаТърсиш грешката в целия класВръщаш стъпката и я правиш пак: червеното сочи нея, защото преди нея всичко беше зелено

5. След изчистването фирменият план е един нов клас, а класът за таксуването не се пипа. Кой принцип е това?

Една причина за промянаОтворено за разширение, затворено за промянаЗависимост от абстракция

Провери

Започни урока отначало

Свързани уроци

• Нужно отпреди: Миризмите: дълъг метод, голям клас, дублиране, примитиви вместо типове, дълга верига if · Тестовете като предпазна мрежа · Refactoring на малки стъпки · SOLID без догма
• Задачи по темата: Чист код и refactoring