Evitando o Jenga® Driven Development @ RubyConf BR 2017

Mover e remover código. Algo que fazemos praticamente todos os dias da nossa vida como programadores. O que podemos aprender a respeito de algo aparentemente tão mundano? Quais detalhes são frequentemente negligenciados e nos causam, silenciosamente, uma diversidade de problemas?

Transcript

1. Jenga® Driven Development
2. Jenga? Jogo criado pela Leslie Scott e hoje distribuído pela Hasbro.
3. Jenga? O objetivo é mover peças de camadas intermediárias para o topo sem derrubar a torre.
4. Jenga? É um jogo divertido. Mas tenso, nervoso, dá ansiedade.
5. Jenga® Driven Development Evitando o
6. Olá João Britto Plataformatec britto noteu
12. Estamos contratando! http:/ /careers.plataformatec.com.br
18. Parte 1 Mo’ Code Mo’ Problems
19. Feature Creep
20. Feature Creep
21. –Grant Ammons “A product with lots of features does not make a great product. A great product is one that solves the customer’s problem in the simplest way possible. Great products deliver value, not features.”
22. maximizar valor ! e minimizar custo "
23. –Sandi MacPherson “Whenever you build a new feature, you’re entering into a contract to keep that code up-to-date and compatible with all other features you’ll choose to add in the future.”
24. –Jeff Atwood “Every new line of code you willingly bring into the world is code that has to be debugged, code that has to be read and understood, code that has to be supported. Every time you write new code, you should do so reluctantly, under duress, because you completely exhausted all your other options.”
25. –Edsger W. Dijkstra “…if we wish to count lines of code, we should not regard them as ‘lines produced’ but as ‘lines spent’.”
26. –Mike Perham “No code runs faster than no code. No code has fewer bugs than no code. No code uses less memory than no code. No code is easier to understand than no code.”
27. No code is easier to delete than no code.
28. –Thomas Figg “The easiest code to delete is the code you avoided writing in the first place.”
29. Parte 2 Código Removível
30. Coisas mudam • Features nascem, crescem e eventualmente morrem. • Ainda faz sentido no contexto atual do meu produto? • Tem usuários suficientes para justificar sua existência? • Representa uma vulnerabilidade na stack? ou seja… • Está mais atrapalhando do que ajudando?
31. –Sandi Metz “The problem with poorly designed small applications is that if they are successful they grow up to be poorly designed big applications.”
32. Maslow
33. Maslow
34. Código pouco “removível” module Animals ANIMALS = %i(cat dog fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.dog; "WOOF!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => "WOOF!"
35. Código pouco “removível” module Animals ANIMALS = %i(cat dog fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.dog; "WOOF!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => "WOOF!"
36. Código pouco “removível” module Animals ANIMALS = %i(cat dog fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => NoMethodError: undefined method `dog' for Animals:Module
37. Código pouco “removível” module Animals ANIMALS = %i(cat dog fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => NoMethodError: undefined method `dog' for Animals:Module
38. Código pouco “removível” module Animals ANIMALS = %i(cat fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => "What does the dog say?"
39. Código mais “removível” module Animals ANIMALS = { cat: "MEOW!", dog: "WOOF!", fox: "WHAT!" } def self.say(animal) ANIMALS[animal] || "What does the #{animal} say?" end end Animals.say(:dog) # => "WOOF!" Animals.say(:cow) # => "What does the cow say?"
40. Código mais “removível” module Animals ANIMALS = { cat: "MEOW!", dog: "WOOF!", fox: "WHAT!" } def self.say(animal) ANIMALS[animal] || "What does the #{animal} say?" end end Animals.say(:dog) # => "WOOF!" Animals.say(:cow) # => "What does the cow say?"
41. Código mais “removível” module Animals ANIMALS = { cat: "MEOW!", dog: "WOOF!", fox: "WHAT!" } def self.say(animal) ANIMALS[animal] || "What does the #{animal} say?" end end Animals.say(:dog) # => "WOOF!" Animals.say(:cow) # => "What does the cow say?"
42. –Sandi Metz “Dependencies are foreign invaders that represent vulnerabilities, and they should be concise, explicit, and isolated.”
43. –Thomas Figg “Good code isn’t about getting it right the first time. Good code is just legacy code that doesn’t get in the way.”
44. Parte 3 Removendo Código
45. Deveria ser tão simples quanto 1. Apagar o código 2. Apagar os testes 3. Partir pro abraço #
46. Na prática…
47. Na prática…
48. Remoções Perigosas • Inexistente • Incorreta • Incompleta
49. Remoção Inexistente
50. Código intacto def do_stuff(things) do_this(things) do_that(things) do_something_else() finish_doing_stuff() end
51. Código comentado def do_stuff(things) do_this(things) # do_that(things) # do_something_else() finish_doing_stuff() end
52. Código condicionado def do_stuff(things) do_this(things) if false do_that(things) do_something_else() end finish_doing_stuff() end
53. –Ned Batchelder “Most developers don't like getting rid of stuff. They want to keep chunks of code around in case they need them again. They worked hard to write that chunk of code. They debugged it, it works. They don't want to just throw it away.”
54. –Ned Batchelder “If you have a chunk of code you don't need any more, there's one big reason to delete it for real rather than leaving it in a disabled state: to reduce noise and uncertainty.”
55. Psicologia do controle de versão
56. Remoções Perigosas • Inexistente • Incorreta • Incompleta
57. Remoção Incorreta
60. Remoção Incorreta module Animals ANIMALS = %i(cat dog fox) def self.say(animal) if ANIMALS.include?(animal) send(animal) else raise "What does the #{animal} say?" end end def self.cat; "MEOW!"; end def self.fox; "WHAT!"; end end Animals.say(:dog) # => NoMethodError: undefined method `dog' for Animals:Module
61. Dependências ocultas $
62. Remoções Perigosas • Inexistente • Incorreta • Incompleta
63. Remoção Incompleta
64. Sacudir a árvore de dependências
65. Sacudir a árvore de dependências
67. Sacolejo Automático • Reduzir código entregue às máquinas • Passo de compilação/empacotamento • Código morto permanece no repositório
68. Sacolejo Manual • Reduzir código entregue às pessoas • Parte do fluxo de desenvolvimento • Código removido em definitivo
69. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
70. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
71. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
72. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
73. Removendo dependências class CreaturesController < ApplicationController def destroy current_player.creatures.destroy(@creature) respond_to do |format| format.json { head :no_content } end end end
74. Removendo dependências class CreaturesController < ApplicationController def destroy current_player.creatures.destroy(@creature) respond_to do |format| format.json { head :no_content } end end end
75. Removendo dependências class CreaturesController < ApplicationController def destroy current_player.creatures.destroy(@creature) respond_to do |format| format.json { head :no_content } end end end
76. Removendo dependências class Player < ApplicationRecord has_many :creatures, after_remove: :notify_parents def notify_parents(creature) NotifyParentsJob.perform_later(creature) end end
77. Removendo dependências class Player < ApplicationRecord has_many :creatures, after_remove: :notify_parents def notify_parents(creature) NotifyParentsJob.perform_later(creature) end end
78. Removendo dependências class NotifyParentsJob < ApplicationJob queue_as :default def perform(creature) # Async stuff end end
79. Removendo dependências class NotifyParentsJob < ApplicationJob queue_as :default def perform(creature) # Async stuff end end
80. Removendo dependências class Player < ApplicationRecord has_many :creatures, after_remove: :notify_parents def notify_parents(creature) NotifyParentsJob.perform_later(creature) end end
81. Removendo dependências class Player < ApplicationRecord has_many :creatures end
82. Removendo dependências class CreaturesController < ApplicationController def destroy current_player.creatures.destroy(@creature) respond_to do |format| format.json { head :no_content } end end end
83. Removendo dependências class CreaturesController < ApplicationController def destroy respond_to do |format| format.json { head :no_content } end end end
84. Removendo dependências class CreaturesController < ApplicationController def destroy respond_to do |format| format.json { head :no_content } end end end
85. Removendo dependências class CreaturesController < ApplicationController end
86. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
87. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
88. Removendo dependências en: creatures: creature: disable: "Enter sleep mode" enable: "Activate!" sacrifice: "Sacrifice creature </3"
89. Removendo dependências en: creatures: creature: disable: "Enter sleep mode" enable: "Activate!" sacrifice: "Sacrifice creature </3"
90. Removendo dependências en: creatures: creature: disable: "Enter sleep mode" enable: "Activate!"
91. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
92. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
93. Removendo dependências $('.actions').on('click', '.btn-delete-creature', event => { this.showCreatureDeletePrompt(event.target); });
94. Removendo dependências $('.actions').on('click', '.btn-delete-creature', event => { this.showCreatureDeletePrompt(event.target); });
95. Removendo dependências $('.actions').on('click', '.btn-delete-creature', event => { this.showCreatureDeletePrompt(event.target); });
96. Removendo dependências $('.actions').on('click', '.btn-delete-creature', event => { this.showCreatureDeletePrompt(event.target); });
97. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
98. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
99. Removendo dependências module CreaturesHelper def goodbye_to(creature) if creature.enabled? I18n.t('creature.goodbye_to.enabled') else I18n.t('creature.goodbye_to.disabled') end end end
100. Removendo dependências module CreaturesHelper def goodbye_to(creature) if creature.enabled? I18n.t('creature.goodbye_to.enabled') else I18n.t('creature.goodbye_to.disabled') end end end
101. Removendo dependências module CreaturesHelper def goodbye_to(creature) if creature.enabled? I18n.t('creature.goodbye_to.enabled') else I18n.t('creature.goodbye_to.disabled') end end end
102. Removendo dependências module CreaturesHelper def goodbye_to(creature) if creature.enabled? I18n.t('creature.goodbye_to.enabled') else I18n.t('creature.goodbye_to.disabled') end end end
103. Removendo dependências module CreaturesHelper def goodbye_to(creature) if creature.enabled? I18n.t('creature.goodbye_to.enabled') else I18n.t('creature.goodbye_to.disabled') end end end
104. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
105. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
106. Removendo dependências .parting-message { background-color: #ccc; }
107. Removendo dependências .parting-message { background-color: #ccc; }
108. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
109. Removendo dependências <div class="actions"> <span class="parting-message"> <%= goodbye_to(@creature) %> </span> <%= button_to t('.sacrifice'), @creature, method: :delete, class: 'btn-delete-creature' %> </div>
110. Removendo dependências ✨
111. Ferramentas ajudam https:/ /unused.codes/
112. Ferramentas ajudam https:/ /unused.codes/
113. Ferramentas ajudam
114. Ferramentas ajudam
115. Checklist das dependências • CSS, JavaScript, Imagens, assets em geral • Chaves de cache de longa expiração • Tarefas assíncronas • Gemfile • Arquivos de configuração, I18n • Documentação, README, etc. • Receitas de provisionamento • Banco de dados: migrações, tabelas, colunas, views, triggers, etc. • Testes: shared examples, helpers, etc.
116. CSS, JavaScript, Imagens…
117. Chaves de cache
118. Tarefas assíncronas
119. Bibliotecas externas e Gemfile
120. Arquivos de configuração
121. Documentação, README
122. Receitas de provisionamento
123. Banco de dados • Colunas • Índices • Tabelas • Views • Triggers • Migrations
124. Testes • Shared Examples • Shared Helpers • Factories • Fixtures
125. Código tem preço, menos geralmente é mais
126. Escreva seu código pensando no dia de apagá-lo
128. Remover código não é tão simples quanto parece
129. Obrigado! britto noteu
130. Fontes e referências • The Pink Panther in “Pink Outs” • https:/ /youtu.be/1q2hu-mDtKs • Jenga® • https:/ /en.wikipedia.org/wiki/Jenga • Information is beautiful - Codebases • http:/ /www.informationisbeautiful.net/visualizations/million-lines-of-code/ • Feature Creep • https:/ /twitter.com/wakeupmrkim/status/925427903352922114 • Grant Ammons - Killing features — just as important as building them • https:/ /medium.com/@gammons/killing-features-just-as-important-as-building- them-7f4d64223585
131. Fontes e referências • Sandi MacPherson - Tough tradeoffs: Removing product features is hard, but often necessary • https:/ /thenextweb.com/dd/2015/01/18/tough-tradeoffs-removing-product-features- hard-often-necessary/ • Jeff Atwood - The Best Code is No Code At All • https:/ /blog.codinghorror.com/the-best-code-is-no-code-at-all/ • Edsger W. Dijkstra - EWD 1036 • https:/ /www.cs.utexas.edu/~EWD/transcriptions/EWD10xx/EWD1036.html • Mike Perham - Kill Your Dependencies • http:/ /www.mikeperham.com/2016/02/09/kill-your-dependencies/ • Thomas Figg - Write code that is easy to delete, not easy to extend. • https:/ /programmingisterrible.com/post/139222674273/write-code-that-is-easy-to- delete-not-easy-to
132. Fontes e referências • Sandi Metz - Practical Object-Oriented Design in Ruby • http:/ /www.poodr.com/ • Maslow’s Trapezoid of Code Cleaniness • https:/ /twitter.com/KellySutton/status/847875703383117824 • https:/ /twitter.com/compooter/status/847881828224684032 • Refactoring code • https:/ /twitter.com/olarclara/status/928802983130927104 • Ned Batchelder - Deleting code • https:/ /nedbatchelder.com/text/deleting-code.html • Tree Shaking • http:/ /gph.is/2pPEHXx
133. Fontes e referências • Rollup.js • https:/ /rollupjs.org/ • Unused • https:/ /unused.codes/ • Google Chrome Dev Tools Code Coverage Tab • https:/ /developers.google.com/web/updates/2017/04/devtools-release- notes#coverage • Programming skills • https:/ /twitter.com/stephentyrone/status/930825774818455553 • Imagens de arquivo pessoal