Analisando Complexidade de Código Ruby

Analisando Complexidade de Código Ruby

Utilizando Métricas para Encontrar Código que Fede

Cássio MarquesRubyMasters Conf 2011

Saturday, February 26, 2011

Cássio Marques

• código + comida vegan + livros + skate + música

• Taoweb

• Lime

• http://cassiomarques.wordpress.com

• @cassiomarques

Porque analisar o código?

http://www.flickr.com/photos/rovingi/312078231/Saturday, February 26, 2011

Como analisar o código?

Estética

Dificuldade de Manutenção

Abstrações

Métricas

Medir alguma propriedade específica

do código

Objetivo: Quantificar o que antes era abstrato

Métrica ABC

Analisa Complexidade

floggithub.com/seattlerb/flog

AssignementDefinir o valor de uma variável explicitamente

=*=/=-=

etc...

BranchingCriar um novo fluxo de execução

ifelse

elsif (argh!)caseand

orrescueuntilwhile

CallsChamadas a métodos

(Outras implementações usam Condition)

|ABC| = sqrt((A*A)+(B*B)+(C*C))

Mas em Ruby temos mais do que isso!

eval & cia(pontuação alta!!!)

define_methodeval

module_evalclass_eval

instance_eval

blocos/yield

instance_methodmethod_defined?

private_instance_methodprivante_class_methodpublic_instance_method

etc...

Introspecção

Module#includedModule#extendedClass#inheritedmethod_defined

etc...

Ou seja...

Ou seja...METAPROGRAMAÇÃO É COMPLEXO E DIFICULTA

A MANUTENÇÃO DO CÓDIGO

Quando verificar isso no seu código?

Frequentemente

(já deixei para a fase final de um projeto e o

resultado foi traumático)

Complexidade Ciclomática

saikurohttp://saikuro.rubyforge.org/

Mede o número de segmentos linearmente

independentes na execução do código

Grafo direcionado para representar os

caminhos de execução

1 def some_method(value) 2 if value % 2 == 0 3 value.times { |i| puts i } 4 else 5 while value >= 0 6 puts value 7 value -= 1 8 end 9 end10 end

Início

value % 2 == 0

value.times { |i| ...

puts i

while value >= 0

puts value -= 1

puts value

C = A - V + 2PC => Complexidade ciclomática

A => Número de arestas

V => Número de vértices

P => Número de componentes conectados

Pode ser utilizada para definir o número de casos de teste necessários para

ter total cobertura do código

Métrica procedural, mas pode ser usada em código OO no escopo

de métodos

Duplicação de código

flayhttp://ruby.sadi.st/Flay.html

Pesquisa por códigos SEMELHANTES

Resultados são bons candidatos para

refactoring

Código que muda com muita frequência

churngithub.com/danmayer/churn

Código que muda muito == problemas

Indica quantidade de alterações ao longo do

MétodosClasses

Arquivos

git/mercurial

Code Smells

Sintoma que indica algum problema mais

sério

O código pode feder por vários motivos

reekgithub.com/kevinrutherford/reek

Aceita opções sobre quais smells identificar/

ignorar

Atributos

readers/writers (ou getters/setters) podem

expor demais seus objetos

Variáveis de Classe

1 class MyClass2 @@my_class_variable = 13 4 class << self5 attr_accessor :my_other_class_variable6 end7 end

Aumenta o escopo global

Classe Longa

Muitas linhas

Muitas variáveis de instância

Muitos métodos

*provavelmente*fazendo coisa demais!

Método Longo

Lista de Parâmetros Longa

1 def pay_with_credit_card(number, security_code, holder_name, expiration, value)2 # ...3 end

Possíveis soluções

Passar um hash

Encapsular em um objeto

Baixa Coesão

Feature Envy

1 class Cart2 def price3 @item.price + @item.tax4 end5 end

Baixa Coesão

Utility Function

Método que não depende do estado do

objeto

1 class Oven2 def formatted_temperature(sensor)3 "#{sensor.temperature} #{sensor.unit}"4 end5 end

Polimorfismo Simulado

1 def some_method(value) 2 if value > 10 3 if value < 20 4 if value != 15 5 puts "duh" 6 else 7 puts "meh" 8 end 9 end10 end11 end

switch também :)

(o reek ainda não identifica)

Uncommunicative Names

Nomes não refletem a intenção do código

1 class SomeClass 2 def some_method 3 # ... 4 end 5 6 def some_method_2 7 # ... 8 end 9 10 def another_method11 a = 1012 aLocalVariable = 2513 end14 end

Pode ser configurado com uma lista de regexps

default [/^.[0-9]*$/]

Cobertura de Teste

!= “bem testado”

rcovhttp://eigenclass.org/hiki.rb?rcov

Pode indicar trechos do código que foram

negligenciados

Too Simple To Break

Novas funcionalidades são adicionadas, mas continua sem testes

Outros smellse

erros de estilo

roodigithub.com/martinjandrews/roodi

Atribuição de valor dentro de uma

estrutura condicional

1 # Deveria ser foo == 1002 if foo = 1003 # ...4 end

1 # Falso positivo...2 def some_method(value)3 if @value = value4 # ...5 end6 end

case sem cláusula else

1 def some_method(value)2 case value3 when 1..104 puts "Entre 1 e 10"5 when 11..206 puts "Entre 11 e 20"7 end8 end

Classes com muitas linhas de código

(por padrão limita em 300)

Padrão para nome de classes e módulos

(verifica se o nome das classes e módulos está em CamelCase)

cláusulas rescue vazias

1 def calculate_factor(number)2 begin3 SOME_CONSTANT / number4 rescue5 6 end7 end

1 def calculate_factor(number)2 begin3 SOME_CONSTANT / number4 rescue => e5 # Tratar a exceção de alguma forma...6 end7 end

Uso de loops com for

1 def print_list(list)2 for value in list do3 puts value4 end5 end

1 def print_list(list)2 list.each {|value| puts value }3 end

Métodos com muitas linhas de código

(por padrão limita em 20)

Padrão para nomes de métodos

(verifica se os nomes dos métodos estão snake_case)

github.com/flyerhzm/rails_best_practices

rails_best_practices

Mas é muita coisa para gerenciar!

http://metric-fu.rubyforge.org/

metric_fu

saikuro + flog + flay + rcov + reek + roodi + churn +

rails_best_practices

rake metrics:all

Integração Contínua

Métricas ao longo do tempo

Relatórios!

Problema:

O metric_fu acaba virando uma dependência

do seu projeto

github.com/iain/metrical

metrical

$ gem install metrical$ cd /path/of/your/project$ metrical

Dúvidas?

Obrigado!

Analisando Complexidade de Código Ruby

Technology

Transcript of Analisando Complexidade de Código Ruby

CÓDIGO CIVIL DEL ESTADO DE CHIAPAS

Simplicidade e Complexidade

Paradigma Da Complexidade

Prado, e - Complexidade e Praxis

Reforma al Código de Aguas.

Anexo propuesta código mercantil

Código de ética grupo dp

Código Familiar SLP

Código de ética e conduta

Código Procedimientos Civiles SLP

Código de Gobierno Corporativo GEB

Complexidade de Algoritmos - Huffman · 1 Complexidade de Algoritmos - Huffman Huffman Denilson Grosa Fernando Kaway Helder Cesar Complexidade de Algoritmos

Código Sanitario 1934

Código de conducta Residuos 14/15

Código Civil. Libro I

Código civil-guatemala

Complexidade social: teoría e métodotorrescubeiro.weebly.com/uploads/1/1/2/8/11287881/1_complexidade... · exemplos. –Complexidade. –Complexidade social –Epistemoloxía da

Sistemas, caos e complexidade

Código Civil. Libro II

Revista Código Marcial