Começando a utilizar Ruby Style Guides

Começar algo do zero é sempre um desafio, principalmente quando se trata de algo relacionado ao mundo do desenvolvimento de softwares, seja uma linguagem, um framework, lib, um padrão de projeto, etc, é o momento mais comum para se cometer erros e encontrar várias “pegadinhas” pelo caminho.

Porém, imagine iniciar essa caminhada acompanhado de alguém que já conheça o que queremos aprender, provavelmente seria mais fácil, seguindo dicas ou pedindo conselhos sobre qual seria a melhor forma de fazer algo que pretendemos.

Um Style Guide pode ser visto como um “amigo” que está sempre disponível pra pedirmos dicas relacionados a sintaxe e/ou organização do código, por exemplo, em vários deles podemos encontrar dicas como: nomenclatura de variáveis, organização de controle de fluxo, definição de objetos, atribuição de parâmetros e etc.

Lembrando que não é papel do papel do Style Guide resolver problemas do projeto e sim melhorar a escrita e leitura do código, principalmente pensando em manutenções. Podemos comparar um Style Guide com um GPS, ele não te leva ao local que você quer, porém te dá boas dicas de como chegar até lá.

É bem comum e até fácil encontrar vários Ruby Style Guides pela web, porém alguns bem famosos e que recentemente tenho visto vários comentários nas comunidades Ruby ou Ruby on Rails são esses:

Alguns exemplos que podemos encontrar nos Ruby Style Guides:

Indentação

# bad
def self.create_translation(phrase_id, phrase_key, target_locale,
                            value, user_id, do_xss_check, allow_verification)
  ...
end

# good
def self.create_translation(phrase_id,
                            phrase_key,
                            target_locale,
                            value,
                            user_id,
                            do_xss_check,
                            allow_verification)
  ...
end

Condicionais

# bad
if some_condition then
  ...
end

# good
if some_condition
  ...
end

Sintaxe

arr = [1, 2, 3]

# bad
for elem in arr do
  puts elem
end

# good
arr.each { |elem| puts elem }

Geralmente são exibidos trechos de código e dicas de como deixa-lo melhor através das palavras “Bad” e “Good“. Lembrando que existem vários Ruby Style Guides, todos possuem boas dicas de como melhorar a escrita e leitura do código.

Conhece mais algum? Deixa aí nos comentários. 🙂