Elixir Brasil 2020 - Code Smells, Refactoring e Elixir

Code Smells, Refatoração e Elixir uma conversa sobre qualidade de
código

Elaine Naomi Watanabe twitter.com/elaine_nw speakerdeck.com/elainenaomi Engenheira de Software (The RealReal)
Mestrado em Ciência da Computação (USP) slides disponíveis

therealreal.com/careers Referral Source Elaine Naomi Watanabe

The RealReal - Elixir adoption story youtube.com/watch?v=sTs_4T1ufLY

Sobre a Plataformatec...

o que aprontei por lá =) além de trabalhar como
dev Sobre a Plataformatec... twitter.com/elaine_nw/status/1214748684593840128

REFATORAÇÃO

REFATORAÇÃO + ELIXIR

DEFINIÇÃO Code SMells Refatoração Na PRÁTICA Resumo e referências

Code SMells DEFINIÇÃO Refatoração Na PRÁTICA Resumo e referências

REFATORAÇÃO

código sendo refatorado falhando por dias?

código sendo refatorado falhando por dias? REFATORAÇÃO

Alteração da estrutura interna do código Tornar + fácil de
ser compreendida Tornar + fácil de ser alterada Manter comportamento externo Refatoração Refactoring

Refatoração Alteração da estrutura interna do código Tornar + fácil
de ser compreendida Tornar + fácil de ser alterada Manter comportamento externo Refactoring

RefatorAR Reestruturar um software Série de pequenas refatorações Manter o
comportamento externo Refactoring

RefatorAR Refactoring Reestruturar um software Série de pequenas refatorações Manter
o comportamento externo

Reestruturar um software Série de pequenas refatorações Manter o comportamento
externo RefatorAR Refactoring não é qualquer limpeza de código

Martin Fowler 1999

22 code smells 72 técnicas de refatoração 1999

Martin Fowler 22 code smells 72 técnicas de refatoração 1999

a partir de um sistema existente

design/arquitetura + implementação a partir de um sistema existente

design/arquitetura + implementação a partir de um sistema existente como
alterar a estrutura do sistema

design/arquitetura + implementação a partir de um sistema existente como
alterar a estrutura do sistema detecção de code smells

design/arquitetura + implementação detecção de code smells a partir de
um sistema existente como alterar a estrutura do sistema + refatoração

design/arquitetura + implementação detecção de code smells + refatoração a
partir de um sistema existente como alterar a estrutura do sistema

detecção de code smells + refatoração design/arquitetura + implementação a
partir de um sistema existente como alterar a estrutura do sistema promover o redesign

aperfeiçoar o design depois de escrito

evolução contínua do design

2018 +18 anos depois 24 code smells 61 técnicas de
refatoração

2018 visão sobre mundo OO + funcional +18 anos depois
24 code smells 61 técnicas de refatoração

visão sobre mundo OO + funcional 2018 +18 anos depois
24 code smells 61 técnicas de refatoração

encapsulamento coesão composição polimorﬁsmo 2018

encapsulamento coesão composição polimorﬁsmo 2018 em ambos paradigmas

2018 classes? objetos?

modules maps e structs protocols behaviours metaprogramming 2018 classes? objetos?

por que o design é importante?

Do livro Refactoring DESIGN RUIM Funcionalidades acumuladas Tempo

Do livro Refactoring Funcionalidades acumuladas Tempo DESIGN RUIM

Entregas começam a atrasar Mais código para fazer as mesmas
tarefas Pouco reúso de código Código difícil de entender Código difícil de alterar

pensando na evolutibilidade do software

pensando na evolutibilidade do software capacidade de adaptação ao longo
do tempo

o código será mais lido e modiﬁcado do que será
escrito

Do livro Refactoring DESIGN RUIM Hipótese da Estamina do Design
(Design Stamina Hypothesis) DESIGN BOM Funcionalidades acumuladas Tempo

Do livro Refactoring Hipótese da Estamina do Design (Design Stamina
Hypothesis) DESIGN RUIM DESIGN BOM Funcionalidades acumuladas Tempo

Código bem estruturado Fácil de entender Fácil de alterar Fácil
de apagar

Código bem estruturado Fácil de entender Fácil de alterar Fácil
de apagar spark joy

como identiﬁcar o que precisamos refatorar?

Code smells Características do código que normalmente indicam problemas de
design mais profundos no sistema https://martinfowler.com/bliki/CodeSmell.html

design mais profundos no sistema https://martinfowler.com/bliki/CodeSmell.html Também chamados de Bad Smells (maus cheiros)

design mais profundos no sistema https://martinfowler.com/bliki/CodeSmell.html

Código duplicado Duplicated Code

Regra de negócio duplicada Texto duplicado

defmodule CarrinhoCompra do # ... def calcular_frete(cep, assinatura) do if
(Enum.member?([3, 4], assinatura.id)) do 0 else 10.0 * Localizacao.calcular(cep) end end def aplicar_desconto(total, assinatura) do if (Enum.member?([3, 4], assinatura.id)) do total * 0.9 else total end end end

(Enum.member?([3, 4], assinatura.id)) do 0 else 10.0 * Localizacao.calcular(cep) end end def aplicar_desconto(total, assinatura) do if (Enum.member?([3, 4], assinatura.id)) do total * 0.9 else total end end end frete

(Enum.member?([3, 4], assinatura.id)) do 0 else 10.0 * Localizacao.calcular(cep) end end def aplicar_desconto(total, assinatura) do if (Enum.member?([3, 4], assinatura.id)) do total * 0.9 else total end end end desconto no valor total

(Enum.member?([3, 4], assinatura.id)) do 0 else 10.0 * Localizacao.calcular(cep) end end def aplicar_desconto(total, assinatura) do if (Enum.member?([3, 4], assinatura.id)) do total * 0.9 else total end end end contextos diferentes

(Enum.member?([3, 4], assinatura.id)) do 0 else 10.0 * Localizacao.calcular(cep) end end def aplicar_desconto(total, assinatura) do if (Enum.member?([3, 4], assinatura.id)) do total * 0.9 else total end end end que compartilham a mesma condicional

mas cadê o pattern matching? =P

defmodule CarrinhoCompra do # ... def calcular_frete(cep, %{id: 3}), do:
0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end pattern matching

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end frete

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end desconto no valor total

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end código duplicado

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total end regra de negócio misteriosa

cuidado com código que parece duplicado

precisamos entender o domínio para entender se as abstrações fazem
sentido

Nome misterioso Mysterious Name

defmodule Ordem do # ... def exec(i, d) do #
... end end

... end end o que são esses argumentos? o que eles representam?

... end end

... end end o que essa função faz?

defmodule Ordem do # ... def exec(i, d) do i
|> Enum.map(& &1.pco * &1.qtd) |> Enum.sum() |> Kernel.-(d) end end

defmodule Ordem do # ... def exec(i, d) do i
|> Enum.map(& &1.pco * &1.qtd) |> Enum.sum() |> Kernel.-(d) end end o que signiﬁcam essas siglas?

DAR NOMES é uma das duas coisas mais difíceis em
computação https://martinfowler.com/bliki/TwoHardThings.html

DAR NOMES é uma das duas coisas mais difíceis em
computação https://martinfowler.com/bliki/TwoHardThings.html variáveis, funções, módulos devem representar o domínio de negócio

FunÇão Longa Long Function

é uma função longa

é uma função longa mas quão longa?

defmodule Relatorio do def imprimir(usuario, pedido) do imprimir_dados_empresa() IO.puts("Nome: #{usuario.nome}
#{usuario.sobrenome}") pedido.items |> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end

#{usuario.sobrenome}") pedido.items |> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end dados da empresa

#{usuario.sobrenome}") pedido.items |> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end dados do usuário

#{usuario.sobrenome}") pedido.items |> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end dados do pedido (com ﬁltros e cálculos)

Necessidade de separar blocos para entender Vontade de adicionar comentários

Necessidade de separar blocos para entender Vontade de adicionar comentários
que tal criar uma nova função?

Classe Grande Long Class

Classe Grande Long Class módulo

um módulo que faz muitas coisas, que cuida de várias
regras de negócio

defmodule CarrinhoCompra do def calcular_total(items, assinatura) do # ... end
def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end versão com pattern matching

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end cálculo de total de items

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end cálculo de frete (com regras para assinaturas)

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end cálculo de desconto (com regras para assinaturas)

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end envio de email para upgrade de assinatura

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end impressão dos dados do pedido

def calcular_frete(cep, %{id: 3}), do: 0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), do: total def mandar_mensagem_assinatura(%{id: 3}, _), do: nil def mandar_mensagem_assinatura(%{id: 4}, _), do: nil def mandar_mensagem_assinatura(assinatura, usuario), do: Assinatura.enviar_email_upgrade(assinatura, usuario) def imprimir(usuario, pedido) do # ... end end o que esse módulo faz? -> total do pedido -> desconto para assinaturas -> frete de acordo com assinaturas -> email de upgrade de assinatura -> impressão

esses contextos poderiam estar em outros módulos

Lista Longa de PArâmetros Long Parameter List

defmodule Usuario do def criar_usuario(nome, email, senha, apelido, status, ativo,
admin) do # ... end end

defmodule Usuario do def criar_usuario( nome, email, senha, apelido, status,
ativo, admin ) do # ... end end Usuario.criar_usuario/7

Usuario.criar_usuario(

ativo, admin ) do # ... end end

Usuario.criar_usuario("Elaine", nome

Usuario.criar_usuario("Elaine", "teste@teste.com", nome email

Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", nome email senha

Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", "elainenaomi", nome email senha apelido

Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", "elainenaomi", 1, nome email senha apelido status

Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", "elainenaomi", 1, true, nome email senha apelido
status ativo

Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", "elainenaomi", 1, true, false) nome email senha
apelido status ativo admin

status 1 - gratuito 2 - basico 3 - plus
Usuario.criar_usuario("Elaine", "teste@teste.com", "senha", "elainenaomi", 1, true, false) nome email senha apelido status ativo admin

ativo, admin, pais ) do # ... end end

mais de três ou quatro parâmetros? provavelmente existe uma abstração
que poderia ser criada

Inveja de recursos Feature Envy

Acessa mais a dados de outros contextos do que de
seu próprio contexto/módulo Violação do princípio Tell, don't ask Chamadas repetidas a outro módulo

defmodule Pedido do # ... def calcula_total_item(id) do item =
ItemPedido.buscar_item(id) total = (item.preco + item.impostos) * item.quantidade desconto = ItemPedido.buscar_desconto(item) unless is_nil(desconto) do total - total * desconto else total end end end

ItemPedido.buscar_item(id) total = (item.preco + item.impostos) * item.quantidade desconto = ItemPedido.buscar_desconto(item) unless is_nil(desconto) do total - total * desconto else total end end end nesse exemplo, todos os dados vêm de ItemPedido ItemPedido poderia encapsular essa regra

Intimidade inapropriada Inappropriate Intimacy

módulo ou função que conhece e pode alterar detalhes internos
de outros módulos ou funções

módulo ou função que conhece e pode alterar detalhes internos
de outros módulos ou funções dentro do contexto de funções impuras

defmodule Pedido do def cobrar(total, usuario) do cartao = Usuario.buscar_cartao_de_credito(usuario)
if (cartao.status == 3) do gateway = Cartao.buscar_gateway_pagamento(cartao) Gateway.cobrar(gateway, cartao, total) end end end

if (cartao.status == 3) do gateway = Cartao.buscar_gateway_pagamento(cartao) Gateway.cobrar(gateway, cartao, total) end end end detalhes internos

if (cartao.status == 3) do gateway = Cartao.buscar_gateway_pagamento(cartao) Gateway.cobrar(gateway, cartao, total) end end end

if (cartao.status == 3) do gateway = Cartao.buscar_gateway_pagamento(cartao) Gateway.cobrar(gateway, cartao, total) end end end provavelmente essa regra deveria estar encapsulada

Cirurgia com Rifle Shotgun Surgery

é só um exemplo

mas baseados em fatos reais

Mesma alteração em vários arquivos Buscas globais para toda alteração

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), # sem desconto do: total end

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), # sem desconto do: total end Enum.member?([3, 4], assinatura.id)

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), # sem desconto do: total end Enum.member?([3, 4, 8], assinatura.id)

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, _), # sem desconto do: total end Enum.member?([3, 4, 8], assinatura.id) apenas seguindo o design...

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, %{id: 8}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, %{id: 8}), do: total * 0.9 # ... end Enum.member?([3, 4, 8], assinatura.id)

0.0 def calcular_frete(cep, %{id: 4}), do: 0.0 def calcular_frete(cep, %{id: 8}), do: 0.0 def calcular_frete(cep, _), do: 10.0 * Localizacao.calcular(cep) def aplicar_desconto(total, %{id: 3}), do: total * 0.9 def aplicar_desconto(total, %{id: 4}), do: total * 0.9 def aplicar_desconto(total, %{id: 8}), do: total * 0.9 # ... end Enum.member?([3, 4, 8], assinatura.id) e buscando outros lugares para alterar...

defmodule Renovacao do def executar(%{id: id}, user) do case id
do 3 -> Cobranca.cobrar(user, id, 100.0) 4 -> Cobranca.cobrar(user, id, 95.0) 2 -> Cobranca.cobrar(user, id, 50.0) end end end

defmodule Renovacao do def executar(%{id: id}, user) do case id
do 3 -> Cobranca.cobrar(user, id, 100.0) 4 -> Cobranca.cobrar(user, id, 95.0) 8 -> Cobranca.cobrar(user, id, 90.0) 2 -> Cobranca.cobrar(user, id, 50.0) end end end

Alteração Divergente Divergent Change

defmodule Conta do # ... def logar_via_google(dados_google) do # ...
end def logar_via_apple(dados_apple) do # ... end def cobrar_assinatura(assinatura) do # ... end def calcular_desconto_assinatura(assinatura) do # ... end end

end def logar_via_apple(dados_apple) do # ... end def cobrar_assinatura(assinatura) do # ... end def calcular_desconto_assinatura(assinatura) do # ... end end mais de uma razão para mudar

Módulo alterado constantemente Mudanças não relacionadas

Módulo alterado constantemente Mudanças não relacionadas Provavelmente precisamos de novas
abstrações

Generalidade Especulativa Speculative Generalization

campo, parâmetro, função ou módulo não utilizado

campo, parâmetro, função ou módulo não utilizado adicionado para o
futuro...

defmodule Pessoa do def formatar_cpf(%{cpf: cpf}) do # ... end
end

defmodule PessoaFisica do def formatar_documento(%{cpf: cpf}) do # ... end
end

end defmodule PessoaJuridica do def formatar_documento(%{cnpj: cnpj}) do # ... end end

end defmodule PessoaJuridica do def formatar_documento(%{cnpj: cnpj}) do # ... end end utilizado em lugar nenhum nesse exemplo

defmodule Assinatura do # ... def enviar_email(assinatura, true), do: Email.enviar_email_assinatura_ativa(assinatura)
def enviar_email(assinatura, false), do: nil end

def enviar_email(assinatura, false), do: nil end ﬂag

def enviar_email(assinatura, false), do: nil end sempre true...

defmodule CarrinhoCompra do # ... def desconto_item(%{categoria: categoria} = produto)
do case categoria do _ -> produto.desconto end end end

do case categoria do _ -> produto.desconto end end end forçando um padrão

do case categoria do _ -> produto.desconto end end end que não será utilizado

módulos, funções, argumentos utilizados somente pelos casos de teste

Comentários Comments

esse é polêmico

qualquer comentário?

é sobre comentários que explicam o que a função faz

# verifica se o cartão está ativo if (cartao.status == 3) do # ... end end end

e vale sempre lembrar

comentário != documentação

doctests

@doc """ Updates the `key` in `map` with the given
function. If `key` is present in `map` then the existing value is passed to `fun` and its result is used as the updated value of `key`. If `key` is not present in `map`, `default` is inserted as the value of `key`. The default value will not be passed through the update function. ## Examples iex> Map.update(%{a: 1}, :a, 13, fn existing_value -> existing_value * 2 end) %{a: 2} iex> Map.update(%{a: 1}, :b, 11, fn existing_value -> existing_value * 2 end) %{a: 1, b: 11} """ @spec update(map, key, default :: value, (existing_value :: value -> updated_value :: value)) :: map def update(map, key, default, fun) when is_function(fun, 1) do # ...

Agrupamento de dados (Data Clumps) Obsessão por primitivos (Primitive Obsession)
Switches Repetidos (Repeated Switches) Campo temporário (Temporary Field) Cadeias de mensagens (Message Chains) Intermediário (Middle man) Outros code smells

Trocas escusas (Insider Trading) Classes alternativas com interfaces diferentes (Alternative
Classes with Different Interfaces) Classe de dados (Data Class) Herança recusada (Refused Bequest) Elemento ocioso (Lazy Element)

Refatoração Na PRÁTICA DEFINIÇÃO Code SMells Resumo e referências

refatorar? detecção de Code Smell executar a refatoração fazer commit
se sim compilar executar testes

alguns exemplos de refatorações

Renomear Variável Rename variable

... end end

defmodule Ordem do # ... def exec(itens, desconto_total) do #
... end end

... end end representações do contexto de negócio

MUDAR DEClaraçÃo de Função Change Function Declaration

... end end o que essa função faz?

defmodule Ordem do # ... def calcular_total(itens, desconto_total) do #
... end end

def enviar_email(assinatura, false), do: nil end

defmodule Assinatura do # ... def enviar_email(assinatura), do: Email.enviar_email_assinatura_ativa(assinatura) end
remover argumentos

defmodule Assinatura do # ... def enviar_email(%Assinatura{} = assinatura), do:
Email.enviar_email_assinatura_ativa(assinatura) end alterar assinatura da função

Introduzir objeto de parâmetros Introduce Parameter Object

abstração? módulo? struct? estrutura de dados? Introduzir objeto de parâmetros
Introduce Parameter Object

defmodule Relatorio do # ... def extrato_por_intervalo(inicio,fim) do # ...
end end extrato_por_intervalo/2

defmodule Relatorio do # ... def extrato_por_intervalo(intervalo) do # ...
end end %{inicio: "2020-01-10", fim: "2020-02-10"} extrato_por_intervalo/1

defmodule Relatorio do # ... def extrato_por_intervalo(%{ inicio: inicio, fim:
fim }) do # ... end end extrato_por_intervalo/1 pattern matching

defmodule Usuario do def criar_usuario(user) do # ... end end

defmodule Usuario do def criar_usuario(%Usuario{} = usuario) do # ...
end end novo_usuario = %Usuario{ nome: "Elaine", email: "teste@teste.com", senha: "123", apelido: "elainenaomi", status: 1, ativo: true, admin: false } Usuario.criar_usuario(novo_usuario)

REnomear campo Rename Field

defmodule Ordem do # ... def calcular_total(itens, desconto_total) do items
|> Enum.map(& &1.preco * &1.qtd) |> Enum.sum() |> Kernel.-(desconto) end end %{preco: 99.99, qtd: 1}

|> Enum.map(& &1.preco * &1.quantidade) |> Enum.sum() |> Kernel.-(desconto) end end %{preco: 99.99, quantidade: 1}

|> Enum.map(&calcular_total_item/1) |> Enum.sum() |> Kernel.-(desconto) end end Extrair função

defmodule Ordem do # ... def calcular_total_item(%{qtd: _} = item),
do: item.preco * item.qtd def calcular_total_item(item), do: item.preco * item.quantidade end campo legado (em migração)

defmodule Ordem do # ... def calcular_total_item(%{qtd: _} = item),
do: item.preco * item.qtd def calcular_total_item(item), do: item.preco * item.quantidade end novo campo

|> Enum.map(& &1.preco * &1.qtd) |> Enum.sum() |> Kernel.-(desconto) end end %Ordem.ItemPedido {preco: 99.99, qtd: 1}

defmodule Ordem.ItemPedido do @type t :: %__MODULE__{ id: String.t(), nome:
String.t(), preco: Decimal.t(), qtd: integer() } defstruct id: nil, nome: nil, preco: nil, qtd: nil end

String.t(), preco: Decimal.t(), quantidade: integer() } defstruct id: nil, nome: nil, preco: nil, quantidade: nil end

String.t(), preco: Decimal.t(), quantidade: integer() } defstruct id: nil, nome: nil, preco: nil, quantidade: nil end compilador <3

Extrair FUnção Extract Function

defmodule Relatorio do def imprimir(usuario, pedido) do imprimir_dados_empresa() IO.puts("Nome: #{usuario.nome}")
pedido.items |> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end

defmodule Relatorio do def imprimir(usuario, pedido) do imprimir_dados_empresa() imprimir_dados_usuário(usuario) pedido.items
|> Enum.filter(&(&1.status == 3)) |> Enum.map(fn item -> IO.puts("Item: #{item.nome}") IO.puts("Preço: #{item.preco}") IO.puts("Quantidade: #{item.quantidade}") total = item.preco * item.quantidade IO.puts("Total: #{total}") end) end end

defmodule Relatorio do def imprimir(usuario, pedido) do imprimir_dados_empresa() imprimir_dados_usuário(usuario) imprimir_dados_pedido(pedido)
end # ... end

Mover FunçÃO Move Function

ItemPedido.buscar_item(id) total = (item.preco + item.impostos) * item.quantidade desconto = ItemPedido.buscar_desconto(item) unless is_nil(desconto) do total - total * desconto else total end end end

defmodule Pedido do # ... def calcula_total_item(id) do ItemPedido.calcular_valor_item(id) end
end

end podem aparecer outros code smells nesse processo

end podem aparecer outros code smells nesse processo mas é só continuar o ciclo: refatorar, executar testes, fazer commit e reiniciar o processo

Remover código morto Remove Dead Code

defmodule CarrinhoCompras do def calcular_preco_total(item, _flag) do total = item.preco
* item.quantidade if false do # desconto novo usuario total * 0.9 end total end end

defmodule CarrinhoCompras do def calcular_preco_total(item) do item.preco * item.quantidade end
end

Combinar Funções em Classe Combine Functions into Class

Combinar Funções em Classe Combine Functions into Class módulo

end def logar_via_apple(dados_apple) do # ... end def cobrar_assinatura(assinatura) do # ... end def calcular_desconto_assinatura(assinatura) do # ... end end defmodule Login do # ... def logar_via_google(dados_google) do # ... end def logar_via_apple(dados_apple) do # ... end end novo módulo

end def logar_via_apple(dados_apple) do # ... end def cobrar_assinatura(assinatura) do # ... end def calcular_desconto_assinatura(assinatura) do # ... end end defmodule Assinatura do def cobrar_assinatura(assinatura) do # ... end def calcular_desconto_assinatura(assinatura) do # ... end end novo módulo

defmodule Conta do # ... end defmodule Login do #
... end defmodule Assinatura do # ... end melhor isolamento dos domínios e regras de negócio

Remover subclasse Remove subclass

Remover subclasse Remove subclass subtipo

Remover subclasse Remove subclass "submódulo"

end defmodule PessoaJuridica do def formatar_documento(%{cnpj: cnpj}) do # ... end end

end defmodule PessoaJuridica do def formatar_documento(%{cnpj: cnpj}) do # ... end end PessoaJuridica não é utilizado nesse exemplo

end

defmodule Pessoa do def formatar_documento(%{cpf: cpf}) do # ... end
end módulo representando a linguagem do domínio se não existe pessoa jurídica, não faz sentido diferenciar pessoa física

Substituir condicional por polimorfismo Replace Conditional With Polymorphism

defmodule Relatorio do def enviar_relatorio(usuario, conteudo, tipo) do case tipo
do :pdf -> PDF.criar(conteudo) :texto -> Texto.gerar(conteudo, margin: false) _ -> nil end |> Email.enviar(usuario.email, conteudo) end end

do :pdf -> PDF.criar(conteudo) :texto -> Texto.gerar(conteudo, margin: false) _ -> nil end |> Email.enviar(usuario.email, conteudo) end end podemos deﬁnir uma interface

usando protocols

defprotocol Relatorio do def criar_arquivo(conteudo) end defimpl Relatorio, for: PDF
do def criar_arquivo(linhas), do: PDF.criar(linhas) end defimpl Relatorio, for: Texto do def criar_arquivo(conteudo), do: Texto.exibir(conteudo) end

do :pdf -> PDF.criar(conteudo) :texto -> Texto.gerar(conteudo, margin: false) _ -> nil end |> Email.enviar(usuario.email, conteudo) end end

defmodule Relatorio do def enviar_relatorio(usuario, conteudo) do conteudo |> Relatorio.criar_arquivo()
|> Email.enviar(usuario.email, conteudo) end end

Internalizar função (Inline Function) Extrair variável (Extract Variable) Internalizar variável
(Inline Variable) Encapsular variável (Encapsulate Variable) Combinar funções em transformação (Combine Functions into Transform) Separar em fases (Split Phase) Encapsular registro (Encapsulate Record) Encapsular coleção (Encapsulate Collection) Substituir primitivo por objeto (Replace Primitive with Object) Substituir variável temporária por consulta (Replace Temp with Query) Internalizar classe (Inline Class) Ocultar delegação (Hide Delegate) Remover intermediário (Remove Middle Man) Outras refatorações

Substituir algoritmo (Substitute Algorithm) Mover campo (Move Field) Mover instruções
para uma função (Move statements into Function) Mover instruções para os pontos de chamada (Move Statements to Callers) Substituir código internalizado por chamada de função (Replace Inline Code with Function Call) Deslocar instruções (Slide Statements) Dividir laço (Split Loop) Substituir laço por pipeline (Replace Loop with Pipeline) Separar variável (Split Variable) Substituir variável derivada por consulta (Replace Derived Variable with Query) Mudar referência para valor (Change Reference to Value) Mudar valor para referência (Change Value to Reference) Decompor condicional (Decompose Conditional) Consolidar expressão condicional (Consolidate Conditional Expression) Substituir condicional aninhada por cláusulas de guarda (Replace Nested Conditional with Guard Clauses)

Introduzir caso especial (Introduce Special Case) Introduzir asserção (Introduce Assertion)
Separar consulta de modificador (Separate Query from Modifier) Parametrizar função (Parameterize Function) Remover argumento de flag (Remove Flag Argument) Preservar objeto inteiro (Preserve Whole Object) Substituir parâmetro por consulta (Replace Parameter with Query) Substituir consulta por parâmetro (Replace Query with Parameter) Remover método de escrita (Remove Setting Method) Substituir construtor por função de factory (Replace Constructor with Factory Function) Substituir função por comando (Replace Function with Command) Substituir comando por função (Replace Command with Function) Subir método (Pull Up Method) Subir campo (Pull Up Field) Subir corpo do construtor (Pull Up Constructor Body)

Extrair superclasse (Extract Superclass) Substituir subclasse por delegação (Replace Subclass
with Delegate) Substituir superclasse por delegação (Replace Superclass with Delegate) Descer método (Push Down Method) Descer campo (Push Down Field) Substituir código de tipos por subclasses (Replace Type Code with Subclasses)

Coesão Encapsulamento Acoplamento Abstração de Tipos

Coesão Encapsulamento Acoplamento Abstração de Tipos uma lista dos principais
objetivos no processo de refatoração

não esqueçam da importância dos testes

ciclo contínuo de feedback

e ferramentas podem auxiliar nesse processo

hexdocs.pm/credo

refatoração, identiﬁcação de bugs, consistência de código, etc

DESIGN DE CÓDIGO sobre a estrutura do código sobre abstrações
do domínio e regras de negócio sobre código fácil de ser compreendido e alterado sobre como as abstrações interagem entre si

apontam possíveis problemas de design alertam sobre redução da qualidade
indicam possível impacto no negócio CODE SMELLS

REFATORAÇÃO

reorganização contínua do código

é sobre identiﬁcação de code smells e possíveis refatorações

é sobre pequenas mudanças

é sobre evoluir o design do código de maneira saudável

revisão de código por pares pode ser uma parte importante
desse processo

https://sourcelevel.io/code-review-ebook

refatoração != revolução

não é para refatorar só porque existe um code smell

ou tratar todo code smell como um falso positivo

precisamos olhar para o código que deixamos como legado

converse com seu time sobre a importância da qualidade do
código

analisem juntos os trade-offs

negociar quando refatorar faz parte do processo

cuidado com big design up front e overengineering

e não esqueçam:

codar é um processo de comunicação

escrevemos código para pessoas, não para máquinas

Mais sobre qualidade de código? Design de código, SOLID Padrões
de projeto TDD, DDD, Agile

Mais sobre qualidade de software? Design de código, SOLID Padrões
de projeto TDD, DDD, Agile

minhas referências

Functional Design Patterns - Scott Wlaschin https://youtu.be/srQt1NAHYC0 Refactoring Elixir -
Lessons Learned from a Year on Exercism.Io - Devon Estes https://youtu.be/tJJMrtJEK1A Refactoring Techniques for Elixir, Ecto, and Phoenix - Gary Rennie https://youtu.be/V21DAKtY31Q Using Credo to improve your Elixir code - Vitali Tatarintev https://whatdidilearn.info/2018/05/27/using-credo-to-improve-your-elixir-code.html Protocols Are Powerful but Beware - Timmon Verlaan https://timmo.immo/blog/protocols-beware Polymorphism in Elixir - Mustafa Turan https://medium.com/elixirlabs/polymorphism-in-elixir-cd0c765b6929

All the Little Things - Sandi Metz https://youtu.be/8bZh5LMaSmE Evitando o
Jenga Driven Development - João Britto https://pt-br.eventials.com/locaweb/evitando-o-jenga-driven-development-com-joao-britto/ How Elixir made me a better Java programmer - Juliana Helena https://youtu.be/O86LQ58PvKU Arquitetura Hexagonal: mantendo sua aplicação saudável por Camila Campos https://youtu.be/mYWG8Qv8W5k Encontrando equilíbrio do DDD enquanto sua aplicação cresce - Carol Karklis https://pt.slideshare.net/CarolinaKarklisPacke/encontrando-equilbrio-do-ddd-enquanto-sua -aplicao-cresce

thoughtbot.com/upcase/clean-code refactoring.guru elixirschool.com refactoring.com/catalog Mais referências

Exercism.io become a mentor https://exercism.io/become-a-mentor

espero conhecer vocês pessoalmente ano que vem

speakerdeck.com/elainenaomi elainenaomi.dev Inveja de Recursos (Feature Envy) Muito obrigada

ilustrações do undraw.co

Elixir Brasil 2020 - Code Smells, Refactoring e Elixir

Elixir Brasil 2020 - Code Smells, Refactoring e Elixir

More Decks by Elaine Naomi

Other Decks in Programming

Featured

Transcript