Código legado otimização

CÓDIGO LEGADO
Michael Granados / @dgmike

MICHAEL GRANADOS
Conversor de sonhos de grandes investidores em realidade

AGENDA
WTF?
A vítima
Versionamento
Pacotes, pacotes, pacotes...
Um grupo, um código
Testes
Programação Calistênica

A VÍTIMA
http://github.com/dgmike/phpconference2014-vitima

WTF?
Código não orientado a objetos

CÓDIGO LEGADO!
To me, legacy code is simply code without tests.
Michael Feathers

COMECE AGORA!
csv
subversion (svn)
mercurial (hg)
git

PARE DE TRABALHAR NO SERVIDOR!
Tenha uma cópia do projeto em sua máquina
$ cd projeto_que_fiz_download
$ git init
$ git add .
$ git commit -m "Importando projeto para o git"

AHH.... MAS EU TENHO MEDO DESSA "TELA PRETA"
Chega de desculpas: TortoiseGit

LOG DE ATIVIDADES
$ git log --oneline -n 10
0b66a73 Adding stepup uptater
207d43f Updating phpdocumentor to get last corrections
6015990 creating make file
d54aafa some doc misc
b2a8726 misc
c8c3624 Documentor settings
70697d4 Adding phpdocumentor to dev
239f47d Merge pull request #16 from dgmike/enhancement/#14
bf53652 "method" implementation
f3653c8 "method" signature

O QUE MUDOU?
$ git diff --name-only b2a8726..HEAD
.stepuprc
Makefile
composer.json
src/Apolo.php
src/Route.php

FUNCIONA SOMENTE NA MINHA MÁQUINA?
github
gitlab
bitbucket
No seu servidor linux (git init --bare / gitosis)
Na máquina do seu amigo (via ip de rede + ssh)

PACOTES, PACOTES, PACOTES...
Iremos precisar de ferramentas que irão nos auxiliar ao longo de
nossa jornada.
Fazer download do zip e descompactar é tão anos 90...
Utilize algum gerenciador de pacotes: pear, composer, npm,
bower

UTILIZAREMOS COMPOSER
Fácil de instalar
$ curl -sS https://getcomposer.org/installer | php

Fácil de usar
// composer.json
{
"require": {
"monolog/monolog": "1.2.*"
}
}
$ php composer.phar install

Usar em sua aplicação
require 'vendor/autoload.php';

UM GRUPO, UM CÓDIGO
function dinheiro($valor) {
return 'R$ ' . number_format(
$valor, 2, '.', ''
);
}
function precoComDesconto ($produtos, $codigo_promocional = false)
{
$total = 0;
foreach ( $produtos as $produto )
{
$total += $produto['preco_final'];
}
$porcentagem = 0;
if ( count($produtos) == 2 ) {

UM GRUPO, UM CÓDIGO
Tabs vs Espaços?
2 ou 4 espaços?
Final de linha? mac, linux, windows?

EDITORCONFIG.ORG
# .editorconfig
# top-most EditorConfig file
root = true
# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true
# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8
# 4 space indentation
[*.php]
indent_style = space
indent_size = 4

CODESNIFFER
// composer.json
{
"require-dev": {
"squizlabs/php_codesniffer": "*"
}
}
$ composer install

CODESNIFFER
$ ./vendor/bin/phpcs --standard=PSR2 funcoes.php
FILE: ./funcoes.php
--------------------------------------------------------------------------------
FOUND 16 ERROR(S) AFFECTING 10 LINE(S)
--------------------------------------------------------------------------------
7 | ERROR | Expected "foreach (...) {n"; found "foreach(...)n {n"
7 | ERROR | Space found after opening bracket of FOREACH loop
7 | ERROR | Space found before closing bracket of FOREACH loop
7 | ERROR | Expected 0 spaces after opening bracket; 1 found
7 | ERROR | Expected 0 spaces before closing bracket; 1 found
30 | ERROR | Expected "if (...) {n"; found "if (...)n {n"
34 | ERROR | Opening parenthesis of a multi-line function call must be the
| | last content on the line
36 | ERROR | Closing parenthesis of a multi-line function call must be on a
| | line by itself
47 | ERROR | Expected "function abc(...)"; found "function abc (...)"
47 | ERROR | Expected 0 spaces between argument "$codigo_promocional" and
| | closing bracket; 1 found
47 | ERROR | Opening brace should be on a new line

CODESNIFFER
function dinheiro($valor) {
return 'R$ ' . number_format(
$valor, 2, '.', ''
);
}
function precoComDesconto ($produtos, $codigo_promocional = false)
{
$total = 0;
foreach ( $produtos as $produto )
{
}
$porcentagem = 0;
if ( count($produtos) == 2 ) {

CODESNIFFER
function dinheiro($valor)
{
return 'R$ ' . number_format($valor, 2, '.', '');
}
function precoComDesconto($produtos, $codigo_promocional = false)
{
$total = 0;
foreach ($produtos as $produto) {
}
$porcentagem = 0;
if (count($produtos) == 2) {
$porcentagem = 5;
$total = $total - ($total * 5/100);

TESTES
function calculaJuros($produtos, $juros)
{
echo '<pre>'; print_r($produtos); echo '</pre>'; // teste
$total = 0;
foreach($produtos as $produto) {
$total += $produto['valor_real'];
}
$total = $total + ($total * $juros / 100);
die($total); // teste
return $total;
}

TESTES
Pacotes: PHPUnit, SimpleTest
Tipos: unitários, integração, aceitacao

SIMPLETEST
$ php composer.phar require --dev "lastcraft/simpletest:*"

SIMPLETEST
define('SIMPLETEST_DIR', realpath(__DIR__ . '/../../vendor/lastcraft/simpletest'));
require SIMPLETEST_DIR . '/autorun.php';
require SIMPLETEST_DIR . '/web_tester.php';
class TestIndex extends WebTestCase
{
function testHomePage()
{
$this->assertTrue($this->get('http://localhost:3001'));
$this->assertText('Loja Legado');
}
function testCliqueComprarAdicionaLinkCarrinhoDeCompras()
{
$this->assertTrue($this->get('http://localhost:3001'));
$this->assertNoText('Carrinho de compras');

SIMPLETEST
$ php tests/aceitacao/test_index.php
test_index.php
OK
Test cases run: 1/2, Passes: 13, Failures: 0, Exceptions: 0
test_index.php
1) Text [texto inexistente] not detected in [String: Loja Legado Loja Legado Loja Legado Carrinho de compras in testCliqueComprarAdicionaLinkCarrinhoDeCompras
in TestIndex
FAILURES!!!
Test cases run: 1/2, Passes: 12, Failures: 1, Exceptions: 0

PHPUNIT
$ php composer.phar require --dev 'phpunit/phpunit:*'

PHPUNIT
require_once __DIR__ . '/../../funcoes.php';
class FuncoesTest
extends PHPUnit_Framework_TestCase
{
public function testDinheiro()
{
$dinheiro = dinheiro(24);
$this->assertEquals('R$ 24,00', $dinheiro);
}
}

PHPUNIT
$ ./vendor/bin/phpunit tests/unitarios/funcoes_test.php
PHPUnit 4.3.5 by Sebastian Bergmann.
..
Time: 33 ms, Memory: 3.00Mb
OK (2 tests, 4 assertions)

PHPUNIT
$ ./vendor/bin/phpunit --testdox tests/unitarios/funcoes_test.php
PHPUnit 4.3.5 by Sebastian Bergmann.
Funcoes
[x] Dinheiro
[x] Preco com desconto
$ ./vendor/bin/phpunit --tap tests/unitarios/funcoes_test.php
TAP version 13
ok 1 - FuncoesTest::testDinheiro
ok 2 - FuncoesTest::testPrecoComDesconto
1..2

PHPUNIT
O que dá pra fazer?
Mock/Stub
Pre-popular banco de dados
CodeCoverage
Selenium

PROGRAMAÇÃO CALISTÊNICA
é uma forma de atividade que consiste em uma
Calistenia
variedade de exercícios físicos feitos sem equipamentos ou
pesos que têm por objetivo aumentar a força e a flexibilidade
usando o peso do próprio corpo como resistência
Jeff Bay escreveu um artigo no livro "The ThoughtWorks
Antology" entitulado "Object Calisthenics". Ele propõe um
exercício "calistênico" para melhorar o design de software e
ajudar a internalizar princípios de bom design de programação
orientada a objetos

ALGUNS PONTOS RELEVANTES!
PHP não é JAVA!!!
Algumas alterações serão feitas!
São apenas dicas e não regras!

REGRAS DO EXERCÍCIO
1. Use apenas um nível de identação por método
2. Não use else
3. Crie objetos para tipos primitivos e strings
4. Use apenas um ponto por linha
5. Não abrevie
6. Mantenha todas as entidades pequenas
7. Não use classes com mais de duas variáveis instanciadas
8. Não use coleções de primeira-classe
9. Não use Getters/Setters/Properties

USE APENAS UM NÍVEL DE IDENTAÇÃO POR MÉTODO
function ganho($registros)
{
$ganhosTotais = 0;
foreach($registros as $registro) {
foreach ($registro['produtos'] as $produto) {
$ganhosTotais += $produto['valor_real'] - $produto['valor_compra'];
}
}
return $ganhosTotais;
}

USE APENAS UM NÍVEL DE IDENTAÇÃO POR MÉTODO
function ganho($registros)
{
$ganhosTotais = 0;
foreach($registros as $registro) {
$ganhosTotais += ganhosPorRegistro($registro);
}
return $ganhosTotais;
}
function ganhosPorRegistro($registro)
{
$ganhos = 0;
foreach ($registro['produtos'] as $produto) {
$ganhos += $produto['valor_real'] - $produto['valor_compra'];
}
return $ganhos;
}

NUNCA USE ELSE
function precoFinal($produto)
{
if ($produto['desconto'] > 0) {
$precoFinal = $produto['preco'] - ($produto['preco'] * $produto['desconto'] / 100);
} else {
$precoFinal = $produto['preco'];
}
return $precoFinal;
}

NUNCA USE ELSE
{
return $produto['preco'] - ($produto['preco'] * $produto['desconto'] / 100);
}
return $precoFinal = $produto['preco'];
}
Outro exemplo
{
$precoFinal = $produto['preco'];
$precoFinal = $produto['preco'] - ($produto['preco'] * $produto['desconto'] / 100);
}
return $precoFinal;
}

CRIE OBJETOS PARA TIPOS PRIMITIVOS E STRINGS SE ELES
POSSUIREM ALGUM COMPORTAMENTO

function desconto(array $produtos, $desconto)
{
$total = 0;
foreach($produtos as $produto) {
}
return $total - ($total * $desconto / 100);
}

class ProdutosLista {
protected $produtos;
public function __construct(array $produtos) {
$this->produtos = $produtos;
}
public function valor_real_total() {
$total = 0;
foreach ($this->produtos as $produto) {
}
return $total;
}
}

class Numeral {
protected $valor;
public function __construct($valorInicial = 0) {
$this->valor = $valorInicial;
}
public function valor() {
return $this->valor;
}
public function adiciona(Numeral $valor) {
$this->valor += $valor->valor();
}
public function removerPercentual(Numeral $percentual) {
$this->valor -= $this->valor() * $percentual / 100;
}
}

function desconto(ProdutosLista $produtos, Numeral $desconto)
{
$total = new Numeral($produtos->valor_real_total());
$total->removerPercentual($desconto);
return $total;
}

USE APENAS UM PONTO ( -> ) POR LINHA SE NÃO FOR UM
ENCADEAMENTO OU UM GETTER

USE APENAS UM ( -> ) POR LINHA SE NÃO FOR UM
function categoria(ProdutoLista $produtos)
{
return $produtos->primeiro->categoria->nome->humanizado();
}

function categoria(ProdutoLista $produtos)
{
$categoria = $produtos->primeiraCategoria();
$template = $categoria->decorator(new HumanizadoDecorator);
return $template->renderiza();
}

$this possui um valor especial no PHP
class Produtos
{
protected $produtos;
public function primeiraCategoria()
{
// em java: primeiroProduto.categoria()
return $this->primeiroProduto->categoria();
}
}

$this possui um valor especial no PHP
$filtros->adicionaImagem($imagem)
->adicionarFiltro(new PretoBranco)
->adicionarFiltro(new BordaMadeira);

ESTÁ ESCREVENDO A MESMA VARIÁVEL MUITAS VEZES?
Parece que temos um código reutilizado várias vezes.
Talvez tenhamos duplicação de código

O NOME DO MÉTODO ESTÁ MUITO GRANDE?
Talvez sua classe/metodo está executando mais do que deveria.
Talvez tenhamos um problema de responsabilidade

MANTENHA TODAS AS ENTIDADES PEQUENAS
Nada de classes com mais de 50 linhas
Nada de pacotes/diretórios com mais de 10 arquivos

MANTENHA TODAS AS ENTIDADES PEQUENAS
Nada de classes com mais de 100 linhas
Nada de pacotes/diretórios com mais de 15 arquivos

NÃO USE CLASSES COM MAIS DE DUAS VARIÁVEIS
INSTANCIADAS

NÃO USE CLASSES COM MAIS DE CINCO VARIÁVEIS
INSTANCIADAS

USE COLEÇÕES COMO PRIMEIRA-CLASSE
class Usuario
{
protected $fotos = array();
protected $nome = '';
public function nome() { return $this->nome; }
public function linkFotos() {
$links = array();
foreach($this->fotos as $foto) {
$links[] = $foto['link'];
}
return implode("n", $links);
}
}

class Usuario
{
protected $fotos = null;
protected $nome = '';
public function nome() { return $this->nome; }
public function fotos() { return $this->fotos; }
}
ListaFotos {
protected $fotos = array();
}

$fotos->filtrar(...);
$fotos->mapear(...);
$fotos->adicionar(...);
$fotos->original(...);

NÃO USE GETTERS/SETTERS
class Pessoa
{
protected $nome;
public getNome() { return $this->nome; }
public setNome($nome) { $this->nome = $nome; }
}

USE GETTERS/SETTERS
class Pessoa
{
protected $nome;
public getNome() {
return $this->nome;
}
public maiusculizaNome()
{
$this->nome = strtoupper($this->nome);
}
}

SURPRESA!
DOCUMENTE SEU CÓDIGO
// verifica se tem mais de 20 produtos
if ($produtos->total() > 20) {
$produtos->aplicaDesconto(new Desconto(10));
}

DOCUMENTE SEU CÓDIGO
// resgata somente fotos ativas
$fotos = array_map(
$fotos->filter('ativos'),
create_function('$foto', 'return $foto["link"];')
);
Não explique um código ruim, corrijá-o!
$fotos->filter('ativos')->links();

PHPDOC
/**
* Verifica se as credenciais do usuário estão corretas
*
* @todo implementar conexao com banco de dados
* @param String $email Email do usuario
* @param String $senha Senha do usuario
*
* @return Boolean
*/
function verificaLogin(String $email, String $senha) {
// ...
}

DÚVIDAS?
Seu momento de me deixar sem graça! ;-)

OBRIGADO!
@dgmike - http://www.slideshare.net/dgmike

Código legado otimização

Recomendados

Recomendados

Mais conteúdo relacionado

Mais procurados

Mais procurados (20)

Destaque

Destaque (6)

Semelhante a Código legado otimização

Semelhante a Código legado otimização (20)

Código legado otimização