Skip to content

ruby.md

Latest commit

 

History

History
185 lines (143 loc) · 3.39 KB

ruby.md

File metadata and controls

185 lines (143 loc) · 3.39 KB

Ruby

For the most part, we try to adhere to this community driven style guide; however, we have a few modifications and extras.

Table of Contents

Source Code Layout

Everything from here and these points.

  • Avoid using local variables where possible; prefer extracting a method [link]

    # bad
class Foo
  def something
    foo = 'foo'
    bar = 'bar'

    puts foo + bar
  end
end

# good
class Foo
  def something
    puts foo + bar
  end

  private

  def foo
    'foo'
  end

  def bar
    'bar'
  end
end

  • Avoid assigning a variable in a conditional; prefer extraction of a well-named method [link]

    # bad
if something?
  some_variable = 'something'
else
  some_variable = 'nothing'
end

puts some_variable

# better
some_variable = if something?
                  'something'
                else
                  'nothing'
                end

puts some_variable

# best
def some_variable_value
  if something?
    'something'
  else
    'nothing'
  end
end

puts some_variable_value

  • Avoid method chaining if intermediate values have their own meaning; prefer extracting a method [link]

    # ok
[1, 2, '3', nil].select { |val| val.is_a?(Fixnum) }.map { |val| val + 1 }

# better
def raw_array
  [1, 2, '3', nil]
end

def numbers_array
  raw_array.select { |val| val.is_a?(Fixnum) }
end

def incremented_array
  numbers_array.map { |val| val + 1 }
end

incremented_array

  • When method chaining requires multiple lines, put each chained method on it's own line with a leading . [link]

    # ok
one.two.three
  .four

# better
one
  .two
  .three
  .four

  • When a method call or array definition require multiple lines, put each parameter on it's own line. [link]

    # bad
some_method(:foo, :bar,
            :baz)

[:foo, :bar,
 :baz]

# good
some_method(
  :foo,
  :bar,
  :baz
)

[
  :foo,
  :bar,
  :baz
]

Classes & Modules

Everything from here and these points.

  • Prefer private attr_readers over explicit use of instance variables [link]

    class Foo
  def initialize(bar)
    @bar = bar
  end

  # bad
  def something
    puts @bar
  end

  # good (usually the following lines would be above #initialize)
  attr_reader :bar
  private :bar

  def something
    puts bar
  end
end

Strings

Everything from here and these points.