Stepping into Refactoring Code with PHP

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: Code Smells : Indicators that our code needs refactoring, akin to clutter calling for cleanup. Refactoring Techniques : We've familiarized ourselves with Extract Method, Rename Method, and Substitute Algorithm techniques in earlier lessons. OOP in Refactoring : We've learned how to leverage Object-Oriented Programming principles to enhance our code's structure. Code Decoupling and Modularization : Methods to make code easier to manage by minimizing dependencies. 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. Let's look at it: PHP class Game {public static function computeScore($player, $monsters) {$score = 0; foreach ($monsters as $monster) {if ($player->power > $monster) {$score += $player->power - $monster;} else {$score -= $monster - $player->power;}} 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 Method and Rename Method to untangle this: We'll extract the scoring logic into a separate method, scoreChange . We'll rename the original method to computeGameScore . With these adjustments, our improved code might look something like this: PHP // New method to calculate score changes. class Game {private static function scoreChange($power, $monster) {return $power > $monster ? $power - $monster : $monster - $power;} // Refactored method to calculate the game score. public static function computeGameScore($player, $monsters) {$score = 0; foreach ($monsters as $monster) {$score += self::scoreChange($player->power, $monster);} return $score;}} This refactoring has simplified the method and made it easier to modify in the future.

Join the 1M+ learners on CodeSignal

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

Practice Problem 2: Refactoring with OOP and Code Decoupling

Let's consider another example where the game has multiple types of monsters. Each monster type behaves differently when encountered by a player.

PHP

class Game
{
    public static function monsterReaction($monsterType, $player)
    {
        if ($monsterType === "ghost") {
            if ($player->power > 5) {
                echo "The ghost flees in terror!";
            } else {
                echo "The ghost grumbles and attacks!";
            }
        } elseif ($monsterType === "goblin") {
            if ($player->power > 3) {
                echo "The goblin groans and retreats!";
            } else {
                echo "The goblin hacks with its sword!";
            }
        }
        // more monster types...
    }
}

This scenario could also benefit from refactoring using OOP and Code Decoupling:

First, we'll introduce a class Monster with a method reaction that could be overridden by each type of monster.
Then, we'll create child classes Ghost and Goblin that inherit from Monster and implement their own reaction methods.

Under the revised structure, our game code would look like this:

PHP

abstract class Monster
{
    abstract public function reaction($player);
}

class Ghost extends Monster
{
    public function reaction($player)
    {
        if ($player->power > 5) {
            echo "The ghost flees in terror!\n";
        } else {
            echo "The ghost grumbles and attacks!\n";
        }
    }
}

class Goblin extends Monster
{
    public function reaction($player)
    {
        if ($player->power > 3) {
            echo "The goblin groans and retreats!\n";
        } else {
            echo "The goblin hacks with its sword!\n";
        }
    }
}

// Game class where List of Monsters is managed
class Game
{
    public static function main($args)
    {
        $player = new Player(4); // This is just an example instantiation.
        $monsters = [new Ghost(), new Goblin(), new Ghost(), new Goblin()];

        foreach ($monsters as $monster) {
            $monster->reaction($player);
        }
    }
}

Now, our code dealing with multiple monsters is easier to manage and can be extended to accommodate more types of monsters.

Stepping into Refactoring Code with PHP