Applying the Law of Demeter in Kotlin

Welcome to the third lesson of the "Applying Clean Code Principles" course. In our journey so far, we've discussed the importance of the DRY (Don't Repeat Yourself) principle to eliminate redundancy in code. We followed that with the KISS (Keep It Simple, Stupid) principle, which highlights the value of simplicity in software development. Today, our focus is on the Law of Demeter — a key guideline in object-oriented programming. By limiting the knowledge that an object has about other objects, this lesson will guide you in crafting more maintainable and modular code. 🤓

The Law of Demeter was introduced by Karl J. Lieberherr and suggests that an object should only communicate with its immediate collaborators, avoiding reliance on the entire system. By reducing dependency between parts, you'll find your code easier to maintain and scale. In simple terms, a method X of class C should only call methods of:

• Class C itself
• An object created by X
• An object passed as an argument to X
• An object held in an instance variable of C
• A companion object

With these principles, you control how parts of your application interact, leading to a more organized structure. Let's explore how this works with examples. 🚀

For the first point, a method should only access its own class's methods:

class Car {
    fun start() {
        checkFuel()
        ignite()
    }
    
    private fun checkFuel() {
        println("Checking fuel level...")
    }
    
    private fun ignite() {
        println("Igniting the engine...")
    }
}

In this example, the start method interacts solely with methods within the Car class itself. This demonstrates how you maintain clear boundaries while adhering to the Law of Demeter.

Next, a method can interact with the objects it creates:

class Library {
    fun borrowBook(title: String): Book {
        val book = Book(title)
        book.issue()
        return book
    }
}

class Book(private val title: String) {
    fun issue() {
        println("Book issued: $title")
    }
}

Here, the Library class creates a Book and calls the issue method on it. This usage pattern complies with the Law of Demeter, where Library interacts with the newly-created Book. 📚

Continuing, let's look at interacting with objects passed as arguments:

class Printer {
    fun print(document: Document) {
        document.sendToPrinter()
    }
}

class Document {
    fun sendToPrinter() {
        println("Document is being printed...")
    }
}

The Printer class's method print communicates with the Document object passed as an argument, aligning with the Law of Demeter by limiting communication to direct method parameters. 🖨️

Objects held in instance variables of a class can also be accessed:

class House {
    private val door = Door()
    
    fun lockHouse() {
        door.close()
    }
}

class Door {
    fun close() {
        println("Door is closed.")
    }
}

In this example, the House class interacts with its door through the lockHouse method, showcasing compliance by interacting with an object it holds in an instance variable. 🏠

Finally, let's see a method interacting with companion objects. While companions can act like static fields, they should be used cautiously:

class TemperatureConverter {
    companion object {
        private const val conversionFactor = 9.0 / 5.0
    }
    
    fun celsiusToFahrenheit(celsius: Int): Int {
        return (celsius * conversionFactor).toInt() + 32
    }
}

Here, conversionFactor resides within a companion object to indicate that it's a constant and to ensure correct calculations. Accessing companion objects like this is compliant with the Law of Demeter. 🌡️

Here's an example that violates the Law of Demeter:

class Person(private val address: Address) {
    fun getAddressDetails(): String {
        return "Address: ${address.firstName} ${address.lastName}, " +
               "${address.street}, ${address.city}, " +
               "${address.country}, ZipCode: ${address.zipCode}"
    }
}

class Address(
    val firstName: String, 
    val lastName: String, 
    val street: String, 
    val city: String, 
    val country: String, 
    val zipCode: String
)

In this case, Person is directly accessing multiple fields through Address, leading to tight coupling. Person relies on the internal structure of Address, which might result in fragile code.

Let's refactor the previous code to adhere to the Law of Demeter:

class Person(private val address: Address) {
    fun getAddressDetails(): String {
        return address.getAddressLine()
    }
}

class Address(
    private val firstName: String, 
    private val lastName: String, 
    private val street: String, 
    private val city: String, 
    private val country: String, 
    private val zipCode: String
) {
    fun getAddressLine(): String {
        return "$firstName $lastName, $street, $city, $country, ZipCode: $zipCode"
    }
}

By encapsulating all the address details within the getAddressLine method in the Address class, the dependency is minimized, and Person no longer accesses Address's internals directly.

The Law of Demeter plays a vital role in writing clean, modular code by ensuring objects only interact with their closest dependencies. By understanding and implementing these guidelines, you enhance the modularity and maintainability of your code. As you move on to the practice exercises, challenge yourself to apply these principles and evaluate your code's interactions. Keep these lessons in mind as essential steps toward mastering clean code! 🌟