Простой рефакторинг кода на основе WordPress

Еще в 2011 году я много читал о работе с устаревшим кодом, качестве кода и рефакторинге.

Есть цитата Мартина Фаулера (который буквально написал книгу о рефакторинге), приписываемая дяде Бобу, которая с тех пор запомнилась мне — и я уверен, многим программистам:

всегда оставляйте код в лучшем состоянии, чем вы его нашли

Дело в том, что эта конкретная идея заключается в том, что я думаю, что она может звучать немного более идеалистично, пока вы действительно не начнете пытаться практиковать ее во всем, что делаете.

То есть, если вы принимаете это за чистую монету, это звучит так, как будто каждый раз, когда вам нужно работать над кодовой базой, вам нужно оставить всю кодовую базу лучше, чем когда вы ее нашли. Но чем больше я пытался применять это правило в своей повседневной работе, тем практичнее, чище и удобнее становился код, специфичный для WordPress.

Итак, когда дело доходит до рефакторинга кода на основе WordPress, как это выглядит?

Это не будет длинный пост. Вместо этого я просто поделюсь несколькими пунктами, которым я следую, когда дело доходит до работы над кодом, который я написал ранее, с которым я столкнулся от других, или с кодовой базой, над которой я работал с другими в мимо.

В произвольном порядке:

• Не будьте идеалистами; Будьте практичны. Рефакторинг всей кодовой базы не является практикой, особенно если кодовая база не заключена в модульные тесты. Посмотрите на код, над которым вы работаете, и посмотрите, какие незначительные изменения вы можете внести, чтобы улучшить его.
• Используйте последние стандарты. Вам не нужно настраивать совершенно новую среду разработки для старого кода. Вместо этого просто убедитесь, что у вас есть хорошие анализаторы кода. Если вы перешли от стандартов кодирования WordPress к PSR, посмотрите на предупреждения или уведомления, которые выдают снифферы, и попытайтесь обновить код только в этом файле (или наборе файлов).
• Напишите вспомогательные функции. Если ваши функции слишком длинные, поищите способы упростить работу с ними. Сначала обновите все управляющие структуры, такие как циклы или условные операторы, а затем напишите вспомогательные функции, чтобы их было легче читать.
• Добавьте тесты (если возможно). Если у вас уже есть инфраструктура модульного тестирования, добавьте тесты для нового кода. Если у вас нет времени или нет фреймворка, не переживайте. Как бы ни проповедовали прагматичные программисты, не всегда есть время добавлять тесты. (Это не заявление о том, что они бесполезны или не должны быть включены, но что не всегда практично включать их в любой момент времени).

Некоторые из вещей, которые я делал в недавних проектах, также включают простые вещи:

• обновление имен переменных и функций в соответствии с PSR,
• замена табуляций на пробелы,
• добавление вспомогательных функций, чтобы сделать условия и циклы более читабельными,
• разделение классов, чтобы они имели более высокую степень сплоченности,
• улучшить докблоки каждой функции

Это лишь некоторые из примеров, и это явно не исчерпывающий список. Но дело не в этом. Вместо этого я хочу просто поделиться тем, как вы можете применять рефакторинг кода на основе WordPress, одновременно выполняя свою повседневную работу управляемым способом.

Все вышеперечисленные изменения или рекомендации — это то, что обычно можно сделать с помощью IDE, несколькими ярлыками и, может быть, с получасом дополнительного времени (и я либерален с этой оценкой).

Так что нет, вам не нужно переписывать всю кодовую базу. Я даже не знаю, является ли это практической целью, к которой нужно стремиться. Но вы можете починить одну маленькую часть общей системы, за которую вы отвечаете?

А почему бы хотя бы не стремиться к этому?