Layout

• Utilizzare UTF-8 come codifica del file sorgente.

• Utilizzare un rientro di 2 spazi, senza tabulazioni.

• Usare terminazioni di riga in stile Unix.

• Evitare l'uso di ; per separare dichiarazioni ed espressioni.

• Usare un'espressione per riga.

• Usare gli spazi intorno agli operatori, dopo le virgole, i punti e le virgole, intorno a { e prima di }.

• Evitare gli spazi dopo (, [ e prima di ], ).

• Evitare gli spazi dopo l'operatore !

• Evitare gli spazi all'interno dei letterali di intervallo.

• Evitare gli spazi intorno agli operatori di chiamata di metodo.

# bad
foo . bar

# good
foo.bar

• Evitare lo spazio nelle dichiarazioni lambda.

# bad
a = -> (x, y) { x + y }

# good
a = ->(x, y) { x + y }

• Indentare when allo stesso livello del case.

• Quando si assegna il risultato di un'espressione condizionale a una variabile, allineare i suoi rami con la variabile che riceve il valore di ritorno.

# bad
result =
  if some_cond
    # ...
    # ...
    calc_something
  else
    calc_something_else
  end

# good
result = if some_cond
  # ...
  # ...
  calc_something
else
  calc_something_else
end

• Quando si assegna il risultato di un blocco begin, allineare rescue/ensure/end con l'inizio della riga.

# bad
host = begin
         URI.parse(value).host
       rescue URI::Error
         nil
       end

# good
host = begin
  URI.parse(value).host
rescue URI::Error
  nil
end

• Usare linee vuote tra le definizioni dei metodi e anche per suddividere internamente i metodi in paragrafi logici.

• Usare gli spazi intorno all'operatore = quando si assegnano valori predefiniti ai parametri dei metodi.

• Evitare la continuazione di riga con \ quando non è necessaria.

• Allineare i parametri di una chiamata di metodo, se si estendono su più righe, con un livello di rientro rispetto all'inizio della riga con la chiamata di metodo.

# starting point (line is too long)
def send_mail(source)
  Mailer.deliver(to: "[email protected]", from: "[email protected]", subject: "Messaggio importante", body: source.text)
end

# bad (double indent)
def send_mail(source)
  Mailer.deliver(
      to: "[email protected]",
      from: "[email protected]",
      subject: "Messaggio importante",
      body: source.text)
end

# good
def send_mail(source)
  Mailer.deliver(
    to: "[email protected]",
    from: "[email protected]",
    subject: "Messaggio importante",
    body: source.text,
  )

• Quando si concatenano metodi su più righe, indentare le chiamate successive di un livello di indentazione.

# bad (indented to the previous call)
User.pluck(:name)
    .sort(&:casecmp)
    .chunk { |n| n[0] }

# good
User
  .pluck(:name)
  .sort(&:casecmp)
  .chunk { |n| n[0] }

• Allinea gli elementi delle matrici letterali che si estendono su più righe.

• Limitare le righe a 120 caratteri.

• Evitare gli spazi bianchi di coda.

• Evitare spazi bianchi aggiuntivi, tranne che per l'allineamento.

• Terminare ogni file con una newline.

• Evitare i commenti a blocchi.

# bad
=begin
comment line
another comment line
=end

# good
# comment line
# another comment liney

• Posizionare la parentesi di chiusura del metodo sulla riga dopo l'ultimo argomento quando la parentesi di apertura si trova su una riga separata dal primo argomento.

# bad
method(
  arg_1,
  arg_2)

# good
method(
  arg_1,
  arg_2,
)

• Separare i commenti magici dal codice e dalla documentazione con una riga vuota.

# bad
# frozen_string_literal: true
# Some documentation for Person
class Person
  # Some code
end

# good
# frozen_string_literal: true

# Some documentation for Person
class Person
  # Some code
end

• Utilizzare linee vuote intorno agli accessi agli attributi.

# bad
class Foo
  attr_reader :foo
  def foo
    # do something...
  end
end

# good
class Foo
  attr_reader :foo

  def foo
    # do something...
  end
end

• Evitare le righe vuote intorno ai corpi dei metodi, delle classi, dei moduli e dei blocchi.

# bad
class Foo

  def foo

    begin

      do_something do

        something

      end

    rescue

      something

    end

    true

  end

end

# good
class Foo
  def foo
    begin
      do_something do
        something
      end
    rescue
      something
    end
  end
end