Übungsaufgaben zu lesbarem Code: Konventionen, Namen, Kommentare und Command-Query-Separation

public class Kostenbeitragsrechner {

    /** Höchstsatz nach den Regeln des Mitfahrlabors: 0,10 Euro je km und Person. */
    public static final int HOECHSTSATZ_CENT_JE_KM_UND_PERSON = 10;

    /**
     * Berechnet die Summe der Kostenbeiträge aller Mitfahrenden einer Fahrt.
     * Ein höherer Wunschsatz wird auf den Höchstsatz begrenzt.
     *
     * @param streckeKm Länge der Fahrt in Kilometern
     * @param anzahlMitfahrende Zahl der Mitfahrenden ohne die fahrende Person
     * @param wunschsatzCentJeKm gewünschter Satz in Cent je km und Person
     * @return Summe der Kostenbeiträge in Cent
     */
    public int berechneKostenbeitraegeCent(int streckeKm, int anzahlMitfahrende, int wunschsatzCentJeKm) {
        int satzCentJeKm = Math.min(wunschsatzCentJeKm, HOECHSTSATZ_CENT_JE_KM_UND_PERSON);
        return streckeKm * satzCentJeKm * anzahlMitfahrende;
    }

    public static void main(String[] args) {
        System.out.println(new Kostenbeitragsrechner().berechneKostenbeitraegeCent(18, 3, 12));  // 540
    }
}

HOECHSTSATZ_CENT_JE_KM_UND_PERSON = 10
"""Höchstsatz nach den Regeln des Mitfahrlabors: 0,10 Euro je km und Person."""


class Kostenbeitragsrechner:

    def berechne_kostenbeitraege_cent(self, strecke_km: int, anzahl_mitfahrende: int,
                                      wunschsatz_cent_je_km: int) -> int:
        """Berechnet die Summe der Kostenbeiträge aller Mitfahrenden einer Fahrt in Cent.

        Ein höherer Wunschsatz (Cent je km und Person) wird auf den Höchstsatz begrenzt.
        """
        satz_cent_je_km = min(wunschsatz_cent_je_km, HOECHSTSATZ_CENT_JE_KM_UND_PERSON)
        return strecke_km * satz_cent_je_km * anzahl_mitfahrende


print(Kostenbeitragsrechner().berechne_kostenbeitraege_cent(18, 3, 12))  # 540

public class MonitorzeileDoku {

    /**
     * Erzeugt die Anzeigezeile eines Fahrtangebots für die Flurmonitore.
     * Die Zeile enthält keine personenbezogenen Daten.
     *
     * @param haltepunkt öffentlicher Haltepunkt, an dem die Fahrt beginnt
     * @param richtung Ziel bzw. Richtung der Fahrt
     * @param abfahrt Abfahrtszeit im Format HH:MM
     * @param freiePlaetze Zahl der noch freien Plätze
     * @return Anzeigezeile, z. B. "Gütersloh Hbf -> DBH-Berufskolleg, 07:05 Uhr, 2 frei"
     */
    public String erzeuge(String haltepunkt, String richtung, String abfahrt, int freiePlaetze) {
        return haltepunkt + " -> " + richtung + ", " + abfahrt + " Uhr, " + freiePlaetze + " frei";
    }
}

def erzeuge(haltepunkt: str, richtung: str, abfahrt: str, freie_plaetze: int) -> str:
    """Erzeugt die Anzeigezeile eines Fahrtangebots für die Flurmonitore.

    Die Zeile enthält keine personenbezogenen Daten.

    Args:
        haltepunkt: öffentlicher Haltepunkt, an dem die Fahrt beginnt
        richtung: Ziel bzw. Richtung der Fahrt
        abfahrt: Abfahrtszeit im Format HH:MM
        freie_plaetze: Zahl der noch freien Plätze

    Returns:
        Anzeigezeile, z. B. "Gütersloh Hbf -> DBH-Berufskolleg, 07:05 Uhr, 2 frei"
    """
    return f"{haltepunkt} -> {richtung}, {abfahrt} Uhr, {freie_plaetze} frei"


print(erzeuge("Gütersloh Hbf", "DBH-Berufskolleg", "07:05", 2))

// vollständiger Stand aus src/kata/java/stand-02: Position.java
package de.csbrad.shop;

/** Eine Bestellposition; Preise sind Nettopreise in Cent, Gewichte in Gramm. */
public record Position(String artikelnr, String bezeichnung, int nettopreisCent, int menge, int gewichtGramm, boolean istRad) {
}

// vollständiger Stand aus src/kata/java/stand-02: Shop.java
package de.csbrad.shop;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Shop {

    private static final int ERSTE_BESTELLNUMMER = 1001;
    private static final String GUTSCHEINCODE_KURIER = "KURIER10";
    private static final int GUTSCHEIN_RABATT_PROZENT = 10;
    private static final int PAKETPAUSCHALE_CENT = 690;
    private static final int HOECHSTGEWICHT_PAKET_GRAMM = 31500;
    private static final int VERSANDKOSTENFREI_AB_CENT = 10000;
    private static final int SPEDITION_JE_RAD_CENT = 4900;
    private static final int MEHRWERTSTEUER_PROZENT = 19;

    private int naechsteBestellnummer = ERSTE_BESTELLNUMMER;
    private final List<Object[]> bestellungen = new ArrayList<>();
    private final List<String> postausgang = new ArrayList<>();
    private final Map<Integer, Integer> mehrwertsteuerCache = new HashMap<>();

    public List<Object[]> getBestellungen() {
        return bestellungen;
    }

    public List<String> getPostausgang() {
        return postausgang;
    }

    private int vergibBestellnummer() {
        int bestellnummer = naechsteBestellnummer;
        naechsteBestellnummer = naechsteBestellnummer + 1;
        return bestellnummer;
    }

    /**
     * Berechnet die Beträge einer Bestellung, verschickt die Bestätigungsmail und speichert die Bestellung.
     *
     * @return {Warenwert, Rabatt, Versandkosten, Mehrwertsteuer, Gesamtbetrag} in Cent
     */
    public int[] abschliessen(List<Position> positionen, String versandart, String gutscheincode, String kundenEmail, boolean express) {
        int warenwert = 0;
        for (Position position : positionen) {
            if (position.menge() <= 0) {
                throw new IllegalArgumentException("Menge muss positiv sein: " + position.artikelnr());
            }
            warenwert = warenwert + position.nettopreisCent() * position.menge();
        }
        int rabatt = 0;
        if (gutscheincode != null && gutscheincode.equals(GUTSCHEINCODE_KURIER)) {
            int warenwertFuerRabatt = 0;
            for (Position position : positionen) {
                warenwertFuerRabatt = warenwertFuerRabatt + position.nettopreisCent() * position.menge();
            }
            // kaufmännisch gerundet
            rabatt = (warenwertFuerRabatt * GUTSCHEIN_RABATT_PROZENT + 50) / 100;
        }
        int versandkosten = 0;
        String versandbezeichnung;
        if (versandart.equals("PAKET")) {
            // Räder passen in kein Paket; die Freigrenze gilt für den Warenwert nach Rabatt
            int gesamtgewicht = 0;
            for (Position position : positionen) {
                if (position.istRad()) {
                    throw new IllegalArgumentException("Räder können nicht als Paket versandt werden");
                }
                gesamtgewicht = gesamtgewicht + position.gewichtGramm() * position.menge();
            }
            int anzahlPakete = gesamtgewicht / HOECHSTGEWICHT_PAKET_GRAMM;
            if (gesamtgewicht % HOECHSTGEWICHT_PAKET_GRAMM > 0 || anzahlPakete == 0) {
                anzahlPakete = anzahlPakete + 1;
            }
            if (warenwert - rabatt >= VERSANDKOSTENFREI_AB_CENT) {
                versandkosten = 0;
            } else {
                versandkosten = anzahlPakete * PAKETPAUSCHALE_CENT;
            }
            versandbezeichnung = "Paket";
        } else if (versandart.equals("SPEDITION")) {
            int anzahlRaeder = 0;
            for (Position position : positionen) {
                if (position.istRad()) {
                    anzahlRaeder = anzahlRaeder + position.menge();
                }
            }
            // ohne Rad wird eine Speditionspauschale berechnet
            if (anzahlRaeder == 0) {
                anzahlRaeder = 1;
            }
            versandkosten = anzahlRaeder * SPEDITION_JE_RAD_CENT;
            versandbezeichnung = "Spedition";
        } else if (versandart.equals("ABHOLUNG")) {
            versandkosten = 0;
            versandbezeichnung = "Abholung";
        } else {
            throw new IllegalArgumentException("Unbekannte Versandart: " + versandart);
        }
        if (warenwert == 0) {
            throw new IllegalArgumentException("Bestellung ohne Warenwert");
        }
        // Preise sind Nettopreise; die Mehrwertsteuer kommt auf Waren und Versand
        int nettobetrag = warenwert - rabatt + versandkosten;
        int mehrwertsteuer;
        if (mehrwertsteuerCache.containsKey(nettobetrag)) {
            mehrwertsteuer = mehrwertsteuerCache.get(nettobetrag);
        } else {
            mehrwertsteuer = (nettobetrag * MEHRWERTSTEUER_PROZENT + 50) / 100;
            mehrwertsteuerCache.put(nettobetrag, mehrwertsteuer);
        }
        int gesamtbetrag = nettobetrag + mehrwertsteuer;
        int bestellnummer = vergibBestellnummer();
        String mailtext;
        if (versandart.equals("ABHOLUNG")) {
            mailtext = "An: " + kundenEmail + "\nBestellung CSB-" + bestellnummer + "\nGesamtbetrag: " + (gesamtbetrag / 100) + ","
                    + String.format("%02d", gesamtbetrag % 100) + " EUR";
            mailtext = mailtext + "\nAbholung in der Werkstatt Bielefeld-Sennestadt";
        } else {
            mailtext = "An: " + kundenEmail + "\nBestellung CSB-" + bestellnummer + "\nGesamtbetrag: " + (gesamtbetrag / 100) + ","
                    + String.format("%02d", gesamtbetrag % 100) + " EUR";
            mailtext = mailtext + "\nVersand: " + versandbezeichnung;
        }
        postausgang.add(mailtext);
        bestellungen.add(new Object[] {"CSB-" + bestellnummer, kundenEmail, positionen, gesamtbetrag});
        return new int[] {warenwert, rabatt, versandkosten, mehrwertsteuer, gesamtbetrag};
    }
}

# vollständiger Stand aus src/kata/python/stand-02: csbrad/position.py
from dataclasses import dataclass


@dataclass(frozen=True)
class Position:
    """Eine Bestellposition; Preise sind Nettopreise in Cent, Gewichte in Gramm."""

    artikelnr: str
    bezeichnung: str
    nettopreis_cent: int
    menge: int
    gewicht_gramm: int
    ist_rad: bool

# vollständiger Stand aus src/kata/python/stand-02: csbrad/shop.py
from csbrad.position import Position

ERSTE_BESTELLNUMMER = 1001
GUTSCHEINCODE_KURIER = "KURIER10"
GUTSCHEIN_RABATT_PROZENT = 10
PAKETPAUSCHALE_CENT = 690
HOECHSTGEWICHT_PAKET_GRAMM = 31500
VERSANDKOSTENFREI_AB_CENT = 10000
SPEDITION_JE_RAD_CENT = 4900
MEHRWERTSTEUER_PROZENT = 19


class Shop:

    def __init__(self) -> None:
        self._naechste_bestellnummer = ERSTE_BESTELLNUMMER
        self._bestellungen: list[list[object]] = []
        self._postausgang: list[str] = []
        self._mehrwertsteuer_cache: dict[int, int] = {}

    def get_bestellungen(self) -> list[list[object]]:
        return self._bestellungen

    def get_postausgang(self) -> list[str]:
        return self._postausgang

    def _vergib_bestellnummer(self) -> int:
        bestellnummer = self._naechste_bestellnummer
        self._naechste_bestellnummer = self._naechste_bestellnummer + 1
        return bestellnummer

    def abschliessen(self, positionen: list[Position], versandart: str, gutscheincode: str | None,
                     kunden_email: str, express: bool) -> list[int]:
        """Berechnet die Beträge einer Bestellung, verschickt die Bestätigungsmail und speichert die Bestellung.

        Rückgabe: [Warenwert, Rabatt, Versandkosten, Mehrwertsteuer, Gesamtbetrag] in Cent.
        """
        warenwert = 0
        for position in positionen:
            if position.menge <= 0:
                raise ValueError(f"Menge muss positiv sein: {position.artikelnr}")
            warenwert = warenwert + position.nettopreis_cent * position.menge
        rabatt = 0
        if gutscheincode is not None and gutscheincode == GUTSCHEINCODE_KURIER:
            warenwert_fuer_rabatt = 0
            for position in positionen:
                warenwert_fuer_rabatt = warenwert_fuer_rabatt + position.nettopreis_cent * position.menge
            # kaufmännisch gerundet
            rabatt = (warenwert_fuer_rabatt * GUTSCHEIN_RABATT_PROZENT + 50) // 100
        versandkosten = 0
        if versandart == "PAKET":
            # Räder passen in kein Paket; die Freigrenze gilt für den Warenwert nach Rabatt
            gesamtgewicht = 0
            for position in positionen:
                if position.ist_rad:
                    raise ValueError("Räder können nicht als Paket versandt werden")
                gesamtgewicht = gesamtgewicht + position.gewicht_gramm * position.menge
            anzahl_pakete = gesamtgewicht // HOECHSTGEWICHT_PAKET_GRAMM
            if gesamtgewicht % HOECHSTGEWICHT_PAKET_GRAMM > 0 or anzahl_pakete == 0:
                anzahl_pakete = anzahl_pakete + 1
            if warenwert - rabatt >= VERSANDKOSTENFREI_AB_CENT:
                versandkosten = 0
            else:
                versandkosten = anzahl_pakete * PAKETPAUSCHALE_CENT
            versandbezeichnung = "Paket"
        elif versandart == "SPEDITION":
            anzahl_raeder = 0
            for position in positionen:
                if position.ist_rad:
                    anzahl_raeder = anzahl_raeder + position.menge
            # ohne Rad wird eine Speditionspauschale berechnet
            if anzahl_raeder == 0:
                anzahl_raeder = 1
            versandkosten = anzahl_raeder * SPEDITION_JE_RAD_CENT
            versandbezeichnung = "Spedition"
        elif versandart == "ABHOLUNG":
            versandkosten = 0
            versandbezeichnung = "Abholung"
        else:
            raise ValueError(f"Unbekannte Versandart: {versandart}")
        if warenwert == 0:
            raise ValueError("Bestellung ohne Warenwert")
        # Preise sind Nettopreise; die Mehrwertsteuer kommt auf Waren und Versand
        nettobetrag = warenwert - rabatt + versandkosten
        if nettobetrag in self._mehrwertsteuer_cache:
            mehrwertsteuer = self._mehrwertsteuer_cache[nettobetrag]
        else:
            mehrwertsteuer = (nettobetrag * MEHRWERTSTEUER_PROZENT + 50) // 100
            self._mehrwertsteuer_cache[nettobetrag] = mehrwertsteuer
        gesamtbetrag = nettobetrag + mehrwertsteuer
        bestellnummer = self._vergib_bestellnummer()
        if versandart == "ABHOLUNG":
            mailtext = ("An: " + kunden_email + "\nBestellung CSB-" + str(bestellnummer) + "\nGesamtbetrag: "
                        + str(gesamtbetrag // 100) + "," + f"{gesamtbetrag % 100:02d}" + " EUR")
            mailtext = mailtext + "\nAbholung in der Werkstatt Bielefeld-Sennestadt"
        else:
            mailtext = ("An: " + kunden_email + "\nBestellung CSB-" + str(bestellnummer) + "\nGesamtbetrag: "
                        + str(gesamtbetrag // 100) + "," + f"{gesamtbetrag % 100:02d}" + " EUR")
            mailtext = mailtext + "\nVersand: " + versandbezeichnung
        self._postausgang.append(mailtext)
        self._bestellungen.append(["CSB-" + str(bestellnummer), kunden_email, positionen, gesamtbetrag])
        return [warenwert, rabatt, versandkosten, mehrwertsteuer, gesamtbetrag]

public class Fahrtangebot {

    private final String haltepunkt;
    private int freiePlaetze;

    public Fahrtangebot(String haltepunkt, int plaetze) {
        this.haltepunkt = haltepunkt;
        this.freiePlaetze = plaetze;
    }

    public String getHaltepunkt() {
        return haltepunkt;
    }

    /** Abfrage: liefert die Zahl der freien Plätze (0, wenn das Angebot voll ist) und ändert nichts. */
    public int getFreiePlaetze() {
        return freiePlaetze;
    }

    /**
     * Kommando: reserviert einen Platz für eine Mitfahrt.
     *
     * @throws IllegalStateException wenn kein Platz mehr frei ist
     */
    public void reservierePlatz() {
        if (freiePlaetze == 0) {
            throw new IllegalStateException("Kein freier Platz ab " + haltepunkt);
        }
        freiePlaetze = freiePlaetze - 1;
    }
}

class Fahrtangebot:

    def __init__(self, haltepunkt: str, plaetze: int) -> None:
        self._haltepunkt = haltepunkt
        self._freie_plaetze = plaetze

    def get_haltepunkt(self) -> str:
        return self._haltepunkt

    def get_freie_plaetze(self) -> int:
        """Abfrage: liefert die Zahl der freien Plätze (0, wenn das Angebot voll ist) und ändert nichts."""
        return self._freie_plaetze

    def reserviere_platz(self) -> None:
        """Kommando: reserviert einen Platz für eine Mitfahrt.

        Raises:
            ValueError: wenn kein Platz mehr frei ist
        """
        if self._freie_plaetze == 0:
            raise ValueError(f"Kein freier Platz ab {self._haltepunkt}")
        self._freie_plaetze = self._freie_plaetze - 1

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;

class FahrtangebotTest {

    @Test
    void abfragenAendertNichts() {
        Fahrtangebot angebot = new Fahrtangebot("Gütersloh Hbf", 3);
        assertEquals(3, angebot.getFreiePlaetze());
        assertEquals(3, angebot.getFreiePlaetze());
    }

    @Test
    void reservierungVerbrauchtGenauEinenPlatz() {
        Fahrtangebot angebot = new Fahrtangebot("Gütersloh Hbf", 3);
        angebot.reservierePlatz();
        assertEquals(2, angebot.getFreiePlaetze());
    }

    @Test
    void vollesAngebotLehntReservierungAb() {
        Fahrtangebot angebot = new Fahrtangebot("Gütersloh Hbf", 1);
        angebot.reservierePlatz();
        assertThrows(IllegalStateException.class, angebot::reservierePlatz);
        assertEquals(0, angebot.getFreiePlaetze());
    }
}

import pytest

from fahrtangebot import Fahrtangebot


def test_abfragen_aendert_nichts() -> None:
    angebot = Fahrtangebot("Gütersloh Hbf", 3)
    assert angebot.get_freie_plaetze() == 3
    assert angebot.get_freie_plaetze() == 3


def test_reservierung_verbraucht_genau_einen_platz() -> None:
    angebot = Fahrtangebot("Gütersloh Hbf", 3)
    angebot.reserviere_platz()
    assert angebot.get_freie_plaetze() == 2


def test_volles_angebot_lehnt_reservierung_ab() -> None:
    angebot = Fahrtangebot("Gütersloh Hbf", 1)
    angebot.reserviere_platz()
    with pytest.raises(ValueError):
        angebot.reserviere_platz()
    assert angebot.get_freie_plaetze() == 0