Stepping into Refactoring Code

Welcome to our captivating session on refactoring, a powerful tool for tidying up code, much like organizing a messy toy box or finding a faster route to school.

Just as each line of code is as essential as a brick in a building, clumsy code may lead to an unstable structure. Today, we'll focus on enhancing the readability, maintainability, and performance of our code through refactoring.

Recapping Crucial Concepts

Let's briefly revisit a few key concepts using Go:

  • Code Smells: Indicators that our code needs refactoring, akin to clutter calling for cleanup.
  • Refactoring Techniques: We've familiarized ourselves with Extract Function, Rename Function, and Substitute Algorithm techniques in earlier lessons.
  • Go's Structs and Interfaces: We leverage structs for data organization and interfaces for defining behaviors, enabling cleaner and more maintainable code.
  • Code Decoupling and Modularization: Techniques to organize code effectively, minimizing dependencies and coupling, making the code easier to manage.

We'll use these concepts as guiding stars as we traverse the cosmos of refactoring.

Practice Problem 1: Taming a Complex Function

We'll start by rewriting a complex game score computation function in Go. Let's look at it:

package main

type Player struct {
    Power int
}

func ComputeScore(player Player, monsters []int) int {
    score := 0
    for _, monster := range monsters {
        if player.Power > monster {
            score += player.Power - monster
        } else {
            score -= player.Power - monster
        }
    }
    return score
}

This code uses an algorithm to adjust the score based on the player's and monsters' power. The parts player.Power > monster and player.Power - monster recur in this function, indicating room for refactoring. We'll apply the Extract Function and Rename Function techniques to untangle this:

  • We'll extract the scoring logic into a separate function, ScoreChange.
  • We'll rename the original function to ComputeGameScore.

With these adjustments, our improved code might look something like this:

package main

type Player struct {
    Power int
}

// New function to calculate score changes.
func ScoreChange(power, monster int) int {
    if power > monster {
        return power - monster
    }
    return monster - power
}

// Refactored function to calculate the game score.
func ComputeGameScore(player Player, monsters []int) int {
    score := 0
    for _, monster := range monsters {
        score += ScoreChange(player.Power, monster)
    }
    return score
}

This refactoring has simplified the function and made it easier to modify in the future.

Sign up
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal