Skip to content

Instantly share code, notes, and snippets.

@superacidjax
Created June 25, 2013 14:50
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save superacidjax/5859072 to your computer and use it in GitHub Desktop.
Save superacidjax/5859072 to your computer and use it in GitHub Desktop.
Some examples of proper Ruby Style
class SomeClass
SOME_CONSTANT = 'upper case name'
def initialize(attributes)
@some_attribute = attributes[:some_attribute]
@another_attribute = attributes[:another_attribute]
@user_factory = attributes[:user_factory]
end
def method_with_arguments(argument_one, argument_two)
this_is_a_really_long_line_that_should_be_broken_up_over_multiple_lines_and.
every_line_but_the_first_is_indented
end
def method_with_multiline_block
some_method_before_block(should_be_followed_by_a_newline)
items.each do |item|
do_something_with_item
end
some_method_after_block(should_follow_after_newline)
end
def method_with_single_line_block
items.map { |item| item.some_attribute }
end
def method_that_returns_an_array
[item_one, item_two]
end
def method_that_returns_a_hash
{ key: 'value' }
end
def method_with_large_hash
{
one: 'value',
two: => 'value'
}
end
def invoke_method_with_arguments_on_multiple_lines
some_method(
i_am_a_long_variable_name_that_i_will_never_fit_on_one_line_with_others,
two,
three
)
# Bad:
some_method(one,
two)
end
def method_that_uses_infix_operators
left + middle - right
end
def method_without_arguments
if complex_condition?
positive_branch
else
negative_branch
end
rest_of_body
end
def method_that_uses_factory
user = @user_factory.new
user.ensure_authenticated!
end
def self.class_method
method_body
end
private
def complex_condition?
part_one? && part_two?
end
end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment