Applying DRY Principles in PHP Code

Welcome to the very first lesson of the "Applying Clean Code Principles in PHP" course! In this lesson, we will focus on a fundamental concept in clean coding: the DRY ("Don't Repeat Yourself") principle. Understanding DRY is crucial for writing efficient, maintainable, and clean code. This principle is not just important for coding interviews, but also in everyday software development. Today, we will dive deep into issues caused by repetitive code and explore strategies to combat redundancy. 🚀

Repetitive functionality in code can introduce several issues that affect the efficiency and maintainability of your software:

• Code Bloat: Repeating similar code across different parts of your application unnecessarily increases the size of the codebase. This makes the code harder to navigate and increases the chances of introducing errors.

• Risk of Inconsistencies: When similar pieces of logic are scattered across different areas, it's easy for them to become out of sync during updates or bug fixes. This can result in logic discrepancies and potentially introduce new problems.

• Maintenance Challenges: Updating code often requires modifications in multiple places, leading to increased work and a higher likelihood of errors. Redundant code makes it difficult for developers to ensure all necessary changes have been made consistently.

To adhere to the DRY principle and avoid repeating yourself, several strategies can be employed:

• Extracting Method: Move repeated logic into a dedicated function that can be called whenever needed. This promotes reuse and simplifies updates.

• Extracting Variable: Consolidate repeated expressions or values into variables. This centralizes change, reducing the potential for errors.

• Replace Temp with Query: Use a function to compute values on demand rather than storing them in temporary variables, aiding in readability and reducing redundancy. Note: computing values on demand, instead of re-using previously computed variables, can have a slight performance impace. Most of the time this isn't an issue, but as always, weigh out the pros and cons!

Consider the following problematic code snippet where repetitive logic is used for calculating the total price based on different shipping methods:

function calculateClickAndCollectTotal(Order $order): float {
    $itemsTotal = 0;
    foreach ($order->getItems() as $item) {
        $itemsTotal += $item->getPrice() * $item->getQuantity();
    }
    $shippingCost = $itemsTotal > 100 ? 0 : 5;
    return $itemsTotal + $shippingCost + $order->getTax();
}

function calculatePostShipmentTotal(Order $order, bool $isExpress): float {
    $itemsTotal = 0;
    foreach ($order->getItems() as $item) {
        $itemsTotal += $item->getPrice() * $item->getQuantity();
    }
    $shippingCost = $isExpress ? $itemsTotal * 0.1 : $itemsTotal * 0.05;
    return $itemsTotal + $shippingCost + $order->getTax();
}

Both functions contain duplicated logic for calculating the total price of items, making them error-prone and hard to maintain. Now, let's refactor this code.

By consolidating the shared logic into a separate function, we can eliminate redundancy and streamline updates:

function calculateClickAndCollectTotal(Order $order): float {
    $itemsTotal = calculateItemsTotal($order);
    $shippingCost = $itemsTotal > 100 ? 0 : 5;
    return $itemsTotal + $shippingCost + $order->getTax();
}

function calculatePostShipmentTotal(Order $order, bool $isExpress): float {
    $itemsTotal = calculateItemsTotal($order);
    $shippingCost = $isExpress ? $itemsTotal * 0.1 : $itemsTotal * 0.05;
    return $itemsTotal + $shippingCost + $order->getTax();
}

function calculateItemsTotal(Order $order): float {
    $itemsTotal = 0;
    foreach ($order->getItems() as $item) {
        $itemsTotal += $item->getPrice() * $item->getQuantity();
    }
    return $itemsTotal;
}

By extracting the calculateItemsTotal function, we centralize the logic of item total calculation, leading to cleaner, more maintainable code.

Let's look at another example dealing with repeated calculations for discount rates:

function applyDiscount(float $price, Customer $customer): float {
    $loyaltyDiscount = $customer->getLoyaltyLevel() * 0.02;
    $price *= (1 - $loyaltyDiscount);
    // Additional discounts
    $seasonalDiscount = 0.10;
    $price *= (1 - $seasonalDiscount);
    return $price;
}

Here, the discount rates are scattered throughout the code, which complicates management and updates.

We can simplify this by extracting the discount rates into variables:

function applyDiscount(float $price, Customer $customer): float {
    $loyaltyDiscount = $customer->getLoyaltyLevel() * 0.02;
    $seasonalDiscount = 0.10;
    
    $totalDiscount = 1 - $loyaltyDiscount - $seasonalDiscount;
    $price *= $totalDiscount;
    
    return $price;
}

Now, with the totalDiscount variable, the logic is cleaner, more readable, and allows changes in just one place. 🎉

Our final example involves temporary variables that lead to repetition:

function isEligibleForDiscount(Customer $customer): bool {
    $newCustomer = $customer->getSignUpDate() > (new DateTime())->modify('-3 months');
    return $newCustomer && count($customer->getPurchaseHistory()) > 5;
}

function isEligibleForLoyaltyProgram(Customer $customer): bool {
    $newCustomer = $customer->getSignUpDate() > (new DateTime())->modify('-3 months');
    return $newCustomer || $customer->getLoyaltyLevel() > 3;
}

The variable $newCustomer is used in multiple places, causing duplicated logic.

Let's refactor by extracting the logic into a function, reducing duplication and enhancing modularity:

function isEligibleForDiscount(Customer $customer): bool {
    return isNewCustomer($customer) && count($customer->getPurchaseHistory()) > 5;
}

function isEligibleForLoyaltyProgram(Customer $customer): bool {
    return isNewCustomer($customer) || $customer->getLoyaltyLevel() > 3;
}

function isNewCustomer(Customer $customer): bool {
    return $customer->getSignUpDate() > (new DateTime())->modify('-3 months');
}

By creating the isNewCustomer function, we've simplified the code and made it more maintainable. 🚀

In this lesson, you learned about the DRY principle and strategies like Extracting Method, Extracting Variable, and Replace Temp with Query to eliminate code redundancy. These strategies help to create code that is easier to maintain, enhance, and understand. Next, you'll have the opportunity to apply these concepts in practical exercises, strengthening your ability to refactor code and uphold clean coding standards. Happy coding! 😊