Clean Code with Kotlin: Addressing Class Interaction Smells

Welcome to the very first lesson of the "Clean Code with Multiple Classes" course! 🎉 This course aims to guide you in writing code that's easy to understand, maintain, and enhance. Within the broader scope of clean coding, effective class collaboration is crucial for building well-structured applications. In this lesson, we will delve into the intricacies of class collaboration and coupling — key factors that can make or break the maintainability of your software. Specifically, we'll address some common "code smells" that indicate problems in class interactions and explore ways to resolve them.

Let's dive into the challenges of class collaboration by focusing on four common code smells:

• Feature Envy: Occurs when a method in one class is overly interested in methods or data in another class.
• Inappropriate Intimacy: Describes a situation where two classes are too closely interconnected, sharing private details.
• Message Chains: Refer to sequences of method calls across several objects, indicating a lack of clear abstraction.
• Middle Man: Exists when a class mainly delegates its behavior to another class without adding functionality.

Understanding these code smells will enable you to improve your class designs, resulting in cleaner and more maintainable code.

These code smells can significantly impact system design and maintainability. Let's consider their implications:

• They can lead to tightly coupled classes, making them difficult to modify or extend. 🔧
• Code readability decreases, as it becomes unclear which class is responsible for which functionality.

Addressing these issues often results in code that's not only easier to read but also more flexible and scalable. Tackling these problems can markedly enhance software architecture, making it more robust and adaptable.

Feature Envy occurs when a method in one class is more interested in the fields or methods of another class than its own. Here's an example:

class ShoppingCart {
    private val items = mutableListOf<Item>()

    fun calculateTotalPrice(): Double {
        var total = 0.0
        for (item in items) {
            total += item.price * item.quantity
        }
        return total
    }
}

class Item(val price: Double, val quantity: Int)

In this scenario, calculateTotalPrice() in ShoppingCart overly accesses data from Item, indicating feature envy.

To refactor, consider moving the logic to the Item class:

class ShoppingCart {
    private val items = mutableListOf<Item>()

    fun calculateTotalPrice(): Double {
        var total = 0.0
        for (item in items) {
            total += item.calculateTotal()
        }
        return total
    }
}

class Item(val price: Double, val quantity: Int) {
    fun calculateTotal() = price * quantity
}

Now, each Item calculates its own total, reducing dependency and distributing responsibility appropriately. ✔️