«Мой сосед Легаси», Сергей Федоров, Evil Martians

Мой соседЛегаси

Федоров Сергей, Evil Martians

Проект AmplifrПроект AmplifrПроект Amplifr

Проект Amplifr

— Музыкальная индустрия

— 4 соцсети

— Публикации

— Простая аналитика

Проект AmplifrПроект AmplifrПроект Amplifr


— 100% SMM

— 12 соцсетей

— Публикации

— Аналитика

— Рекомендации

— Рассылки


Эволюция VS Революция

О чем доклад?

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

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

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


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


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








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end








end



stat = \

Stat.record_total(

"soundcloud_plays",


plays_total

)

end

end

super

end


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


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


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


Единый стиль форматированияуменьшает вероятность ошибки

Источник: Robert C. Martin: Clean Code, A Handbook of Agile Software Craftsmanship

http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882

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

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


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


Комментарии могут обманыватьтак же, как и неверные имена


Плохое имя — как магнитдля лишней функциональности


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


def access_token







)


raise Social::API::Unauthorized if new_token.blank?

api

end


def access_token







)


if new_token.blank?

@account.disable!

raise Social::API::Unauthorized

end

api

end


def rest_client_with_refreshed_token

client = Odnoklassniki::Client.new(




)

refreshed_token = client.refresh_token!

raise Social::API::Unauthorized if refreshed_token.blank?

client

end

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

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


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

module Social

module API

class Vkontakte

def initialize(access_token)

@access_token = access_token

end

# ...

end

end

end

module Social

module API

class Twitter



end

# ...

end

end

end


module Social

module API

class Base



end

end

end

end

module Social

module API

class Vkontakte < Base

# ...

end

end

end



module Social

module API

class Base



end

def rescue_api_errors(error, args)

# ..

end

def send_notification

# ...

end

end

end

end


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


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


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


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

ИнтерфейсыИнтерфейсыИнтерфейсы

Интерфейсы

вместо методоввместо методоввместо методов

вместо методов

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

Лучший код — код которого нет


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


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



all = api_fetch








likes ||= 0


shares = 0




end

end



all = api_fetch








likes ||= 0


shares = 0




end

end


def get_publication_activity(story)




likes ||= 0


shares = 0

{likes: likes, comments: comments, shares: shares}

end


class PublicationStatistics

def likes

# ...

end

def comments

# ...

end

def shares

# ...

end

end


Производите анализ имеющегосякода

ТестыТестыТесты

Тесты

Тесты

Код без тестов — легаси код

Источник: Michael Feathers: Working Effectively with Legacy Code

http://www.amazon.com/Working-Effectively-Legacy-Michael-Feathers/dp/0131177052

Тесты

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

Тесты

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

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

Рефакторинг


Довольно дорогой процессдля бизнеса


Очень сложно уложитьсяв отведенное время


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

Заключение

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


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


Разработка через рефакторинг

ВопросыВопросыВопросы

Вопросы

— Почта: [email protected]

— Твиттер: @oni_strech

— Слайды: strech.github.io/my-neighbor-legacy

https://twitter.com/oni_strech

https://strech.github.io/my-neighbor-legacy

Internet

«Мой сосед Легаси», Сергей Федоров, Evil Martians