DEV Community

Cover image for Code Smell 46 - Repeated Code
Maxi Contieri
Maxi Contieri

Posted on • Edited on • Originally published at maximilianocontieri.com

Code Smell 46 - Repeated Code

DRY is our mantra. Teachers tell us to remove duplication. We need to go beyond.

Problems

  • Code Duplication

  • Maintainability

Solutions

  1. Find repeated patterns (not repeated code).

  2. Create an abstraction.

  3. Parametrize abstraction calls.

  4. Use composition and never inheritance.

  5. Unit test new abstraction.

Sample Code

Wrong

<?
class WordProcessor {
function replaceText(string $patternToFind, string $textToReplace) {
$this->text = '<<<' .
str_replace($patternToFind, $textToReplace, $this->text)
. '>>>';
}
}
final class Obfuscator {
function obfuscate(string $patternToFind, string $textToReplace) {
$this->text =
strlower(str_ireplace(
$patternToFind, $textToReplace, $this->text));
}
}
view raw repeated.php hosted with ❤ by GitHub

Right

<?
final class TextReplacer {
function replace(
string $patternToFind,
string $textToReplace,
string $subject,
string $replaceFunctionName,
$postProcessClosure) {
return $postProcessClosure(
$replaceFunctionName($patternToFind,
$textToReplace,
$subject));
}
}
// Lots of tests on text replacer so you can gain confidence.
final class WordProcessor {
function replaceText(string $patternToFind, string $textToReplace) {
$this->text = (new TextReplacer())->replace(
$patternToFind,
$textToReplace,
$this->text,
'str_replace', fn($text) => '<<<' . $text . '>>>');
}
}
final class Obfuscator {
function obfuscate(string $patternToFind, string $textToReplace) {
$this->text = (new TextReplacer())->replace(
$patternToFind,
$textToReplace,
$this->text,
'str_ireplace', fn($text) => strlower($text));
}
}
view raw composed.php hosted with ❤ by GitHub

Detection

Linters can find repeated code.

There are not very good finding similar patterns.

Maybe soon machine learning will help us find such abstractions automatically.

For now, it is up to us, humans.

Tags

  • Duplication

Conclusion

Repeated code is always a smell.

Copying and pasting code is always a shame.

With our refactoring tools, we need to accept the duplication remove challenge trusting our tests as a safety net.

Relations

More info

Don't repeat

Credits

Photo by Sid Balachandran on Unsplash


Copy and paste is a design error.

David Parnas

Heroku

Simplify your DevOps and maximize your time.

Since 2007, Heroku has been the go-to platform for developers as it monitors uptime, performance, and infrastructure concerns, allowing you to focus on writing code.

Learn More

Top comments (0)