Denominazione

Paragrafo sul come gestire i nomi delle variabili, costanti, metodi e altre descrizioni all'interno del codice

• Usare snake_case per simboli, metodi e variabili.

• Usare CamelCase per classi e moduli, ma mantenere acronimi come HTTP, RFC, XML in maiuscolo.

• Usare snake_case per nominare i file e le directory, per esempio hello_world.rb.

• Definire una sola classe o modulo per ogni file sorgente.

• Nominare il nome del file come la classe o il modulo, ma sostituendo CamelCase con snake_case.

• Usare SCREAMING_SNAKE_CASE per le altre costanti.

• Quando si usa inject con blocchi brevi, nominare gli argomenti in base a ciò che viene iniettato, ad esempio |hash, e| (mnemonico: hash, element).

• Quando si definiscono operatori binari, nominare il parametro other (<< e [] sono eccezioni alla regola, poiché la loro semantica è diversa).

• Nominare i metodi di predicato con un ? I metodi di predicato sono metodi che restituiscono un valore booleano.

• Evitare di terminare i nomi dei metodi con un ? se non restituiscono un valore booleano.

• Evitare di anteporre ai nomi dei metodi il prefisso is_.

# bad
def is_empty?
end

# good
def empty?
end

• Evitare di iniziare i nomi dei metodi con get_.

• Evitare di terminare i nomi dei metodi con ! quando non esiste un metodo equivalente senza il bang. I bang servono a contrassegnare una versione più pericolosa di un metodo, ad esempio save restituisce un booleano in ActiveRecord, mentre save! lancia un'eccezione in caso di fallimento.

• Evitare i numeri magici.

• Usare una costante e darle un nome significativo. Evitare una nomenclatura che abbia (o possa essere interpretata come) un'origine discriminatoria.