atzorvas/ccradio

This cop checks for when; uses in case expressions.

Example:

# bad
case foo
when 1; 'baz'
when 2; 'bar'
end
 
# good
case foo
when 1 then 'baz'
when 2 then 'bar'
end

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end
 
# good
# Description/Explanation of Person class
class Person
  # ...
end

This cops checks for parentheses around the arguments in method definitions. Both instance and class/singleton methods are checked.

Example: EnforcedStyle: require_parentheses (default)

# The `require_parentheses` style requires method definitions
# to always use parentheses
 
# bad
def bar num1, num2
  num1 + num2
end
 
def foo descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name
  do_something
end
 
# good
def bar(num1, num2)
  num1 + num2
end
 
def foo(descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name)
  do_something
end

Example: EnforcedStyle: requirenoparentheses

# The `require_no_parentheses` style requires method definitions
# to never use parentheses
 
# bad
def bar(num1, num2)
  num1 + num2
end
 
def foo(descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name)
  do_something
end
 
# good
def bar num1, num2
  num1 + num2
end
 
def foo descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name
  do_something
end

Example: EnforcedStyle: requirenoparenthesesexceptmultiline

# The `require_no_parentheses_except_multiline` style prefers no
# parantheses when method definition arguments fit on single line,
# but prefers parantheses when arguments span multiple lines.
 
# bad
def bar(num1, num2)
  num1 + num2
end
 
def foo descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name
  do_something
end
 
# good
def bar num1, num2
  num1 + num2
end
 
def foo(descriptive_var_name,
        another_descriptive_var_name,
        last_descriptive_var_name)
  do_something
end

This cop checks for when; uses in case expressions.

Example:

# bad
case foo
when 1; 'baz'
when 2; 'bar'
end
 
# good
case foo
when 1 then 'baz'
when 2 then 'bar'
end

This cop checks for when; uses in case expressions.

Example:

# bad
case foo
when 1; 'baz'
when 2; 'bar'
end
 
# good
case foo
when 1 then 'baz'
when 2 then 'bar'
end

This cop checks for when; uses in case expressions.

Example:

# bad
case foo
when 1; 'baz'
when 2; 'bar'
end
 
# good
case foo
when 1 then 'baz'
when 2 then 'bar'
end