Class Collaboration and Coupling

Introduction

Welcome to the very first lesson of the "Clean Code with Traits and 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.

Overview of Class Collaboration Challenges

Let's explore the challenges of class collaboration by focusing on four common code smells: Feature Envy : This 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 intertwined, sharing private details. Message Chains : Refers to sequences of method calls across several objects, indicating a lack of clear abstraction. Middle Man : Exists when a class primarily 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.

Problems Arising During Class Collaboration

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 substantially improve software architecture, making it more robust and adaptable.

Feature Envy

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: Scala case class Item(price: Double, quantity: Int) class ShoppingCart: private val items = List(Item(10.0, 2), Item(15.5, 3)) def calculateTotalPrice: Double = items.map(_.price * _.quantity).sum case class Item(price: Double, quantity: Int) class ShoppingCart: private val items = List(Item(10.0, 2), Item(15.5, 3)) def calculateTotalPrice: Double = items.map(_.price * _.quantity).sum In this scenario, calculateTotalPrice in ShoppingCart overly accesses data from Item, indicating feature envy. To refactor, consider moving the logic to the Item class: Scala case class Item(price: Double, quantity: Int): def calculateTotal: Double = price * quantity class ShoppingCart: private val items = List(Item(10.0, 2), Item(15.5, 3)) def calculateTotalPrice: Double = items.map(_.calculateTotal).sum case class Item(price: Double, quantity: Int): def calculateTotal: Double = price * quantity class ShoppingCart: private val items = List(Item(10.0, 2), Item(15.5, 3)) def calculateTotalPrice: Double = items.map(_.calculateTotal).sum Now, each Item calculates its own total, reducing dependency and distributing responsibility appropriately. ✔️

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Scala

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

class ShoppingCart:
  private val items = List(Item(10.0, 2), Item(15.5, 3))

  def calculateTotalPrice: Double = 
    items.map(_.price * _.quantity).sum

Scala

case class Item(price: Double, quantity: Int):
  def calculateTotal: Double = price * quantity

class ShoppingCart:
  private val items = List(Item(10.0, 2), Item(15.5, 3))

  def calculateTotalPrice: Double = 
    items.map(_.calculateTotal).sum

Scala

case class Book(title: String, author: String)

class Library(books: List[Book]):
  def printBookDetails(): Unit =
    books.foreach(book => println(s"Title: ${book.title}, Author: ${book.author}"))

Scala

case class Book(title: String, author: String):
  def details: String = s"Title: $title\nAuthor: $author"

class Library(books: List[Book]):
  def printBookDetails(): Unit =
    books.foreach(book => println(book.details))

Scala

case class User(address: Address)

case class Address(zipCode: ZipCode)

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.address.zipCode.postalCode

case class User(address: Address)

case class Address(zipCode: ZipCode)

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.address.zipCode.postalCode

Scala

case class User(address: Address):
  def postalCode: String = address.postalCode

case class Address(zipCode: ZipCode):
  def postalCode: String = zipCode.postalCode

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.postalCode

case class User(address: Address):
  def postalCode: String = address.postalCode

case class Address(zipCode: ZipCode):
  def postalCode: String = zipCode.postalCode

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.postalCode

Scala

class Controller(service: Service):
  def execute(): Unit = 
    service.performAction()

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

class Controller(service: Service):
  def execute(): Unit = 
    service.performAction()

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

Scala

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

// Usage
val service = Service()
service.performAction()

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

// Usage
val service = Service()
service.performAction()

Scala

case class Book(title: String, author: String)

class Library(books: List[Book]):
  def printBookDetails(): Unit =
    books.foreach(book => println(s"Title: ${book.title}, Author: ${book.author}"))

Scala

case class Book(title: String, author: String):
  def details: String = s"Title: $title\nAuthor: $author"

class Library(books: List[Book]):
  def printBookDetails(): Unit =
    books.foreach(book => println(book.details))

Scala

case class User(address: Address)

case class Address(zipCode: ZipCode)

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.address.zipCode.postalCode

Scala

case class User(address: Address):
  def postalCode: String = address.postalCode

case class Address(zipCode: ZipCode):
  def postalCode: String = zipCode.postalCode

case class ZipCode():
  def postalCode: String = "90210"

// Usage
val user = User(Address(ZipCode()))
user.postalCode

Scala

class Controller(service: Service):
  def execute(): Unit = 
    service.performAction()

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

Scala

class Service:
  def performAction(): Unit = 
    // Action performed
    println("Service is performing an action.")

// Usage
val service = Service()
service.performAction()

Class Collaboration and Coupling

Introduction

Overview of Class Collaboration Challenges

Problems Arising During Class Collaboration

Feature Envy

Join the 1M+ learners on CodeSignal

Inappropriate Intimacy

Message Chains

Middle Man

Summary and Practice Heads-Up