Выступление на конференции DUMP-2015.

1. Мой сосед
Легаси
Федоров Сергей, Evil Martians

2. Проект AmplifrПроект AmplifrПроект Amplifr
Проект Amplifr
— Музыкальная индустрия
— 4 соцсети
— Публикации
— Простая аналитика

3. Проект AmplifrПроект AmplifrПроект Amplifr
Проект Amplifr
— 100% SMM
— 12 соцсетей
— Публикации
— Аналитика
— Рекомендации
— Рассылки

4. Проект Amplifr
Эволюция VS Революция

5. О чем доклад?
О простых и дешевых приемах,
которые позволят вам и вашей
команде эффективно работать
с легаси кодом

6. ФорматированиеФорматированиеФорматирование
Форматирование

7. Форматирование
Никому не нравится читать плохо
отформатированный код

8. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
update_activity(publication, activity)
total = activity.values.sum
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

9. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

10. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

11. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

12. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

13. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

14. Форматирование
def write_stats(publication, total, data = {})
activity = count_total_from_publication_data(publication)
total = activity.values.sum
update_activity(publication, activity)
if override_stat_date?(publication, 'created_at')
data[:date] = Time.parse(publication.data['created_at'])
end
unless dont_write_stats
if plays_total = publication.data.try(:[], 'playback_count').to_i
stat =
Stat.record_total(
"soundcloud_plays",
{ project: publication.project, resource: publication }.merge(data),
plays_total
)
end
end
super
end

15. Форматирование
Современные IDE поддерживают
функцию автоматического
форматирования кода

16. Форматирование
Концепции, тесно связанные друг
с другом, должны находиться
поблизости друг от друга
по вертикали

17. Форматирование
Взаимозависимые функции
должны размещаться
в нисходящем порядке

18. Форматирование
Единый стиль форматирования
уменьшает вероятность ошибки
Источник: Robert C. Martin: Clean Code, A Handbook of Agile Software Craftsmanship

19. Неправильные именаНеправильные именаНеправильные имена
Неправильные имена

20. Неправильные имена
Самое трудное
в программировании —
это придумывать имена

21. Неправильные имена
Комментарии могут обманывать
так же, как и неверные имена

22. Неправильные имена
Плохое имя — как магнит
для лишней функциональности

23. Неправильные имена
def access_token
# We store only refresh token and for each request
# just fetching new access token
api = Odnoklassniki::Client.new(
access_token: @account.token,
client_id: Settings.odnoklassniki.app_id,
client_secret: Settings.odnoklassniki.app_secret,
)
new_token = api.refresh_token!
raise Social::API::Unauthorized if new_token.blank?
api
end

24. Неправильные имена
def access_token
# We store only refresh token and for each request
# just fetching new access token
api = Odnoklassniki::Client.new(
access_token: @account.token,
client_id: Settings.odnoklassniki.app_id,
client_secret: Settings.odnoklassniki.app_secret,
)
new_token = api.refresh_token!
raise Social::API::Unauthorized if new_token.blank?
api
end

25. Неправильные имена
def access_token
# We store only refresh token and for each request
# just fetching new access token
api = Odnoklassniki::Client.new(
access_token: @account.token,
client_id: Settings.odnoklassniki.app_id,
client_secret: Settings.odnoklassniki.app_secret,
)
new_token = api.refresh_token!
if new_token.blank?
@account.disable!
raise Social::API::Unauthorized
end
api
end

26. Неправильные имена
def rest_client_with_refreshed_token
client = Odnoklassniki::Client.new(
access_token: @account.token,
client_id: Settings.odnoklassniki.app_id,
client_secret: Settings.odnoklassniki.app_secret,
)
refreshed_token = client.refresh_token!
raise Social::API::Unauthorized if refreshed_token.blank?
client
end

27. Дублирование и DRYДублирование и DRYДублирование и DRY
Дублирование и DRY

28. Дублирование и DRY
Все ли дублирование стоит
устранять?

29. module Social
module API
class Vkontakte
def initialize(access_token)
@access_token = access_token
end
# ...
end
end
end
module Social
module API
class Twitter
def initialize(access_token)
@access_token = access_token
end
# ...
end
end
end
Дублирование и DRY

30. module Social
module API
class Base
def initialize(access_token)
@access_token = access_token
end
end
end
end
module Social
module API
class Vkontakte < Base
# ...
end
end
end
Дублирование и DRY

31. Дублирование и DRY
module Social
module API
class Base
def initialize(access_token)
@access_token = access_token
end
def rescue_api_errors(error, args)
# ..
end
def send_notification
# ...
end
end
end
end

32. Дублирование и DRY
Понятность кода не должна быть
ценой устранения дублирования

33. Дублирование и DRY
С дублированием кода вполне
можно жить

34. Дублирование и DRY
Неверные абстракции устранять
сложнее, чем дублирование

35. Дублирование и DRY
Устраняя дублирование
руководствуйтесь примерами
использования кода

36. ИнтерфейсыИнтерфейсыИнтерфейсы
Интерфейсы
вместо методоввместо методоввместо методов
вместо методов

37. Интерфейсы вместо методов
Лучший код — код которого нет

38. Интерфейсы вместо методов
Копирование или расширение
существующих методов — ложный
reuse

39. Интерфейсы вместо методов
def fetch_account_publications(opts = {})
all = api_fetch
posts = all['feeds']
entities = all['entities'].try(:[], 'media_topics') || []
return unless posts.present? || entities.present?
posts.each do |story|
publication = find_publication(story)
likes = entities.find { |it| it['ref'] == story['target_refs'].try(:[], 0) }
likes = likes['like_summary']['count'] if likes
likes ||= 0
comments = story['discussion_summary'].try(:[], 'comments_count').to_i
shares = 0
update_activity(publication, {like: likes, share: shares, comment: comments})
total = comments + likes
write_stats(publication, total) if publication.is_a?(Social::ExternalPublication)
end
end

40. Интерфейсы вместо методов
def fetch_account_publications(opts = {})
all = api_fetch
posts = all['feeds']
entities = all['entities'].try(:[], 'media_topics') || []
return unless posts.present? || entities.present?
posts.each do |story|
publication = find_publication(story)
likes = entities.find { |it| it['ref'] == story['target_refs'].try(:[], 0) }
likes = likes['like_summary']['count'] if likes
likes ||= 0
comments = story['discussion_summary'].try(:[], 'comments_count').to_i
shares = 0
update_activity(publication, {like: likes, share: shares, comment: comments})
total = comments + likes
write_stats(publication, total) if publication.is_a?(Social::ExternalPublication)
end
end

41. Интерфейсы вместо методов
def fetch_account_publications(opts = {})
all = api_fetch
posts = all['feeds']
entities = all['entities'].try(:[], 'media_topics') || []
return unless posts.present? || entities.present?
posts.each do |story|
publication = find_publication(story)
likes = entities.find { |it| it['ref'] == story['target_refs'].try(:[], 0) }
likes = likes['like_summary']['count'] if likes
likes ||= 0
comments = story['discussion_summary'].try(:[], 'comments_count').to_i
shares = 0
update_activity(publication, {like: likes, share: shares, comment: comments})
total = comments + likes
write_stats(publication, total) if publication.is_a?(Social::ExternalPublication)
end
end

42. Интерфейсы вместо методов
def get_publication_activity(story)
publication = find_publication(story)
likes = entities.find { |it| it['ref'] == story['target_refs'].try(:[], 0) }
likes = likes['like_summary']['count'] if likes
likes ||= 0
comments = story['discussion_summary'].try(:[], 'comments_count').to_i
shares = 0
{likes: likes, comments: comments, shares: shares}
end

43. Интерфейсы вместо методов
class PublicationStatistics
def likes
# ...
end
def comments
# ...
end
def shares
# ...
end
end

44. Интерфейсы вместо методов
Производите анализ имеющегося
кода

45. ТестыТестыТесты
Тесты

46. Тесты
Код без тестов — легаси код
Источник: Michael Feathers: Working Effectively with Legacy Code

47. Тесты
Как бы небыл понятен код —
не факт, что ты ничего не сломал

48. Тесты
Критичные участки кода должны
быть покрыты тестами

50. РефакторингРефакторингРефакторинг
Рефакторинг

51. Рефакторинг
Довольно дорогой процесс
для бизнеса

52. Рефакторинг
Очень сложно уложиться
в отведенное время

53. Рефакторинг
Параллельная разработка делает
рефакторинг в разы сложнее

54. Заключение
Правило бойскаута — оставь
место стоянки чище, чем оно было
до твоего прихода

55. Заключение
Теория разбитых окон — устраняя
малозначительные недочеты, вы
не допускаете более крупных

56. Заключение
Разработка через рефакторинг

57. ВопросыВопросыВопросы
Вопросы

58. — Почта: strech@evl.ms
— Твиттер: @oni_strech
— Слайды: strech.github.io/my-neighbor-legacy