Към съдържанието
wannacode

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

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

Проблем

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

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

class RideMgr:
    def __init__(self):
        self.c = {}
        self.s = 0
        self.out = []


    # Цената: 1 € за отключване и 0,15 € на минута.
    # Нощем цената се вдига с 50%.
    def calc(self, to, t, m, f):
        self.c[to] = self.c.get(to, 0) + 1
        p = 0
        if t == "payg":
            p = 1.0 + m * 0.2
        elif t == "student":
            p = (1.0 + m * 0.2) * 0.8
        elif t == "monthly":
            if m > 45:
                p = (m - 45) * 0.2
        if self.c[to] > 3 and t != "monthly":
            p = p - 1.0
        if f:
            p = p + 0.5
        self.s = self.s + p
        self.out.append(f"{to}: {m} мин, {p:.2f} €")
        return p

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

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

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

rides = RideMgr()
shown = rides.calc("ana@example.com", "payg", 10, False)
print(f"Цена преди края: {shown:.2f} €")
charged = rides.calc("ana@example.com", "payg", 10, False)
print(f"Взето: {charged:.2f} €")
print(f"Бележки: {len(rides.out)}")
print(f"Оборот: {rides.s:.2f} €")
Изход
Цена преди края: 3.00 €
Взето: 3.00 €
Бележки: 2
Оборот: 6.00 €

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

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

Виж го

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

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

import unittest


from rides import RideMgr




EMAIL = "ana@example.com"




def money(amount):
    return f"{amount:.2f}"




class RideMgrTest(unittest.TestCase):
    def setUp(self):
        self.rides = RideMgr()


    def ride(self, plan, minutes, night):
        return money(self.rides.calc(EMAIL, plan, minutes, night))


    def test_pay_as_you_go_ride(self):
        self.assertEqual(self.ride("payg", 10, False), "3.00")


    def test_student_ride(self):
        self.assertEqual(self.ride("student", 10, False), "2.40")


    def test_monthly_within_free_minutes(self):
        self.assertEqual(self.ride("monthly", 30, False), "0.00")


    def test_monthly_over_free_minutes(self):
        self.assertEqual(self.ride("monthly", 60, False), "3.00")


    def test_night_surcharge(self):
        self.assertEqual(self.ride("payg", 10, True), "3.50")


    def test_fourth_ride_unlock_is_free(self):
        self.ride("payg", 10, False)
        self.ride("payg", 10, False)
        self.ride("payg", 10, False)
        self.assertEqual(self.ride("payg", 10, False), "2.00")


    def test_student_fourth_ride(self):
        # Така е днес: отстъпката е целият 1 €, а не 0,80 €.
        self.ride("student", 10, False)
        self.ride("student", 10, False)
        self.ride("student", 10, False)
        self.assertEqual(self.ride("student", 10, False), "1.40")


    def test_receipt(self):
        self.ride("payg", 10, False)
        self.assertEqual(self.rides.out, ["ana@example.com: 10 мин, 3.00 €"])


    def test_revenue(self):
        self.ride("payg", 10, False)
        self.ride("student", 10, False)
        self.assertEqual(money(self.rides.s), "5.40")
Резултат
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0

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

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

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

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

print((1.0 + 10 * 0.2) * 0.8)
Изход
2.4000000000000004

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

Виж го

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

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

class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = 0
        self.receipts = []


    # Цената: 1 € за отключване и 0,15 € на минута.
    # Нощем цената се вдига с 50%.
    def finish_ride(self, email, plan, minutes, *, night=False):
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        price = 0
        if plan == "payg":
            price = 1.0 + minutes * 0.2
        elif plan == "student":
            price = (1.0 + minutes * 0.2) * 0.8
        elif plan == "monthly":
            if minutes > 45:
                price = (minutes - 45) * 0.2
        if self.rides_today[email] > 3 and plan != "monthly":
            price = price - 1.0
        if night:
            price = price + 0.5
        self.revenue = self.revenue + price
        self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
        return price

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

В Python night става аргумент само по име (след *) със стойност по подразбиране: денят е без аргумент, а нощта е night=True.
Преди
def ride(self, plan, minutes, night):
    return money(self.rides.calc(EMAIL, plan, minutes, night))


def test_night_surcharge(self):
    self.assertEqual(self.ride("payg", 10, True), "3.50")
След
def ride(self, plan, minutes, *, night=False):
    return money(self.billing.finish_ride(EMAIL, plan, minutes, night=night))


def test_night_surcharge(self):
    self.assertEqual(self.ride("payg", 10, night=True), "3.50")
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0
В PyCharm преименуването е Shift+F6, във VS Code е F2. Атрибутите на обекта (self.s) IDE-то не винаги ги вижда навсякъде, затова тестовете тук казват повече, отколкото в Java или C#.

Виж го

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

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

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

UNLOCK_FEE = 1.00
PER_MINUTE = 0.20
STUDENT_SHARE = 0.80
MONTHLY_FREE_MINUTES = 45
PAID_UNLOCKS_PER_DAY = 3
NIGHT_SURCHARGE = 0.50




class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = 0
        self.receipts = []


    def finish_ride(self, email, plan, minutes, *, night=False):
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        price = 0
        if plan == "payg":
            price = UNLOCK_FEE + minutes * PER_MINUTE
        elif plan == "student":
            price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE
        elif plan == "monthly":
            if minutes > MONTHLY_FREE_MINUTES:
                price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE
        if self.rides_today[email] > PAID_UNLOCKS_PER_DAY and plan != "monthly":
            price = price - UNLOCK_FEE
        if night:
            price = price + NIGHT_SURCHARGE
        self.revenue = self.revenue + price
        self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
        return price
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0

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

Константите са на ниво модул, над класа: така ги вижда и всеки друг код във файла, а в стъпка 5 и плановете.

Пробвай

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

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

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

По-точно, за любопитните
Тестовете
ОК    test_monthly_within_free_minutes
ПАДА  test_fourth_ride_unlock_is_free
ПАДА  test_monthly_over_free_minutes
ПАДА  test_night_surcharge
ПАДА  test_pay_as_you_go_ride
ПАДА  test_receipt
ПАДА  test_revenue
ПАДА  test_student_fourth_ride
ПАДА  test_student_ride
Тестове: 9, минали: 1, паднали: 8

Виж го

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

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

Числата стават Decimal, създаден от низ. Формулите не се пипат, защото Decimal работи с + и *, и с цели числа.
from decimal import Decimal




UNLOCK_FEE = Decimal("1.00")
PER_MINUTE = Decimal("0.20")
STUDENT_SHARE = Decimal("0.80")
MONTHLY_FREE_MINUTES = 45
PAID_UNLOCKS_PER_DAY = 3
NIGHT_SURCHARGE = Decimal("0.50")




class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = Decimal("0")
        self.receipts = []


    def finish_ride(self, email, plan, minutes, *, night=False):
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        price = Decimal("0")
        if plan == "payg":
            price = UNLOCK_FEE + minutes * PER_MINUTE
        elif plan == "student":
            price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE
        elif plan == "monthly":
            if minutes > MONTHLY_FREE_MINUTES:
                price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE
        if self.rides_today[email] > PAID_UNLOCKS_PER_DAY and plan != "monthly":
            price = price - UNLOCK_FEE
        if night:
            price = price + NIGHT_SURCHARGE
        self.revenue = self.revenue + price
        self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
        return price
В тестовете не се сменя нищо: f"{amount:.2f}" работи и с Decimal.
def money(amount):
    return f"{amount:.2f}"
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0

Пробвай

Попълни

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

PER_MINUTE = Decimal()

Виж го

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

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

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

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

def price(self, email, plan, minutes, *, night=False):
    price = Decimal("0")
    if plan == "payg":
        price = UNLOCK_FEE + minutes * PER_MINUTE
    elif plan == "student":
        price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE
    elif plan == "monthly":
        if minutes > MONTHLY_FREE_MINUTES:
            price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE
    if self.rides_today.get(email, 0) > PAID_UNLOCKS_PER_DAY and plan != "monthly":
        price = price - UNLOCK_FEE
    if night:
        price = price + NIGHT_SURCHARGE
    return price


def finish_ride(self, email, plan, minutes, *, night=False):
    price = self.price(email, plan, minutes, night=night)
    self.rides_today[email] = self.rides_today.get(email, 0) + 1
    self.revenue = self.revenue + price
    self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
    return price
Отговор
По-точно, за любопитните
Тестовете
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_ride
ПАДА  test_fourth_ride_unlock_is_free: '3.00' != '2.00'
- 3.00
? ^
+ 2.00
? ^


ПАДА  test_student_fourth_ride: '2.40' != '1.40'
- 2.40
? ^
+ 1.40
? ^


Тестове: 9, минали: 7, паднали: 2

Виж го

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

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

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

def price(self, email, plan, minutes, *, night=False):
    ride_of_day = self.rides_today.get(email, 0) + 1
    price = Decimal("0")
    if plan == "payg":
        price = UNLOCK_FEE + minutes * PER_MINUTE
    elif plan == "student":
        price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE
    elif plan == "monthly":
        if minutes > MONTHLY_FREE_MINUTES:
            price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE
    if ride_of_day > PAID_UNLOCKS_PER_DAY and plan != "monthly":
        price = price - UNLOCK_FEE
    if night:
        price = price + NIGHT_SURCHARGE
    return price


def finish_ride(self, email, plan, minutes, *, night=False):
    price = self.price(email, plan, minutes, night=night)
    self.rides_today[email] = self.rides_today.get(email, 0) + 1
    self.revenue = self.revenue + price
    self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
    return price
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0

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

Целият клас след стъпка 4
from decimal import Decimal




UNLOCK_FEE = Decimal("1.00")
PER_MINUTE = Decimal("0.20")
STUDENT_SHARE = Decimal("0.80")
MONTHLY_FREE_MINUTES = 45
PAID_UNLOCKS_PER_DAY = 3
NIGHT_SURCHARGE = Decimal("0.50")




class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = Decimal("0")
        self.receipts = []


    def price(self, email, plan, minutes, *, night=False):
        ride_of_day = self.rides_today.get(email, 0) + 1
        price = Decimal("0")
        if plan == "payg":
            price = UNLOCK_FEE + minutes * PER_MINUTE
        elif plan == "student":
            price = (UNLOCK_FEE + minutes * PER_MINUTE) * STUDENT_SHARE
        elif plan == "monthly":
            if minutes > MONTHLY_FREE_MINUTES:
                price = (minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE
        if ride_of_day > PAID_UNLOCKS_PER_DAY and plan != "monthly":
            price = price - UNLOCK_FEE
        if night:
            price = price + NIGHT_SURCHARGE
        return price


    def finish_ride(self, email, plan, minutes, *, night=False):
        price = self.price(email, plan, minutes, night=night)
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        self.revenue = self.revenue + price
        self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
        return price

Виж го

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

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

class PayAsYouGo:
    def price(self, minutes):
        return UNLOCK_FEE + minutes * PER_MINUTE


    def loyalty_discount(self):
        return UNLOCK_FEE




class Student:
    def price(self, minutes):
        return PayAsYouGo().price(minutes) * STUDENT_SHARE


    def loyalty_discount(self):
        # Така е днес: целият 1 €, макар че отключването на студента струва 0,80 €.
        return UNLOCK_FEE




class Monthly:
    def price(self, minutes):
        return max(0, minutes - MONTHLY_FREE_MINUTES) * PER_MINUTE


    def loyalty_discount(self):
        return Decimal("0")

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

from decimal import Decimal




UNLOCK_FEE = Decimal("1.00")
PER_MINUTE = Decimal("0.20")
STUDENT_SHARE = Decimal("0.80")
MONTHLY_FREE_MINUTES = 45
PAID_UNLOCKS_PER_DAY = 3
NIGHT_SURCHARGE = Decimal("0.50")




class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = Decimal("0")
        self.receipts = []


    def price(self, email, plan, minutes, *, night=False):
        ride_of_day = self.rides_today.get(email, 0) + 1
        price = plan.price(minutes)
        if ride_of_day > PAID_UNLOCKS_PER_DAY:
            price = price - plan.loyalty_discount()
        if night:
            price = price + NIGHT_SURCHARGE
        return price


    def finish_ride(self, email, plan, minutes, *, night=False):
        price = self.price(email, plan, minutes, night=night)
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        self.revenue = self.revenue + price
        self.receipts.append(f"{email}: {minutes} мин, {price:.2f} €")
        return price
Тук няма интерфейс: всеки план просто има методите price и loyalty_discount, а класът за таксуването ги вика (duck typing). Константите остават на ниво модул.

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

self.assertEqual(self.ride("payg", 10, night=True), "3.50")
self.assertEqual(self.ride(PayAsYouGo(), 10, night=True), "3.50")
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 9, минали: 9, паднали: 0

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

Виж го

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

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

BUSINESS_PER_MINUTE = Decimal("0.18")




class Business:
    def price(self, minutes):
        return minutes * BUSINESS_PER_MINUTE


    def loyalty_discount(self):
        return Decimal("0")

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

billing = RideBilling()
payg = PayAsYouGo()
billing.finish_ride("ana@example.com", payg, 10)
billing.finish_ride("ana@example.com", payg, 5)
billing.finish_ride("ana@example.com", payg, 12, night=True)
print(f"Цена преди края: {billing.price("ana@example.com", payg, 8):.2f} €")
print(f"Цена преди края: {billing.price("ana@example.com", payg, 8):.2f} €")
print(f"Взето: {billing.finish_ride("ana@example.com", payg, 8):.2f} €")
print(f"Фирмата, 12 мин: {billing.finish_ride("office@example.com", Business(), 12):.2f} €")
print(f"Бележки: {len(billing.receipts)}")
Изход
Цена преди края: 1.60 €
Цена преди края: 1.60 €
Взето: 1.60 €
Фирмата, 12 мин: 2.16 €
Бележки: 5

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

Идеята

Преди и след

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

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

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

Преди
rides = 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 receipt in rides.out:
    print(receipt)
print(f"Оборот: {rides.s:.2f} €")
След
billing = RideBilling()
payg = PayAsYouGo()
billing.finish_ride("ana@example.com", payg, 10)
billing.finish_ride("ivan@example.com", Student(), 25)
billing.finish_ride("ana@example.com", payg, 5)
billing.finish_ride("maria@example.com", Monthly(), 60, night=True)
billing.finish_ride("ana@example.com", payg, 12, night=True)
billing.finish_ride("ana@example.com", payg, 8)


for receipt in billing.receipts:
    print(receipt)
print(f"Оборот: {billing.revenue:.2f} €")
Изход
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:
    def __init__(self):
        self.sent = []


    def send(self, email, minutes, price):
        self.sent.append(f"{email}: {minutes} мин, {price:.2f} €")
from decimal import Decimal




UNLOCK_FEE = Decimal("1.00")
PER_MINUTE = Decimal("0.20")
STUDENT_SHARE = Decimal("0.80")
MONTHLY_FREE_MINUTES = 45
PAID_UNLOCKS_PER_DAY = 3
NIGHT_SURCHARGE = Decimal("0.50")




class RideBilling:
    def __init__(self):
        self.rides_today = {}
        self.revenue = Decimal("0")
        self.receipt_book = ReceiptBook()


    def price(self, email, plan, minutes, *, night=False):
        ride_of_day = self.rides_today.get(email, 0) + 1
        price = plan.price(minutes)
        if ride_of_day > PAID_UNLOCKS_PER_DAY:
            price = price - plan.loyalty_discount()
        if night:
            price = price + NIGHT_SURCHARGE
        return price


    def finish_ride(self, email, plan, minutes, *, night=False):
        price = self.price(email, plan, minutes, night=night)
        self.rides_today[email] = self.rides_today.get(email, 0) + 1
        self.revenue = self.revenue + price
        self.receipt_book.send(email, minutes, price)
        return price


    @property
    def receipts(self):
        return self.receipt_book.sent
Тестовете
ОК    test_fourth_ride_unlock_is_free
ОК    test_monthly_over_free_minutes
ОК    test_monthly_within_free_minutes
ОК    test_night_surcharge
ОК    test_pay_as_you_go_ride
ОК    test_receipt
ОК    test_revenue
ОК    test_student_fourth_ride
ОК    test_student_ride
Тестове: 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 €. Какво правиш, докато чистиш класа?
2. Коментарът казва 0,15 € на минута, а кодът взима 0,20 €. На кое вярваш?
3. Защо тестовете викат класа през един помощник, а не директно?
4. Първият опит за стъпка 4 направи два теста червени. Какво правиш?
5. След изчистването фирменият план е един нов клас, а класът за таксуването не се пипа. Кой принцип е това?

Създаден от Иво Гергов като част от кампанията на Evo Tech за достъпно обучение по програмиране ·