module RuboCop::Cop::StatementModifier

Common functionality for modifier cops.

Public Instance Methods

body_length(body) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 55
def body_length(body)
  body.source_range ? body.source_range.size : 0
end
comment_lines() click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 63
def comment_lines
  @comment_lines ||= processed_source.comments.map { |c| c.location.line }
end
commented?(source) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 59
def commented?(source)
  comment_lines.include?(source.line)
end
empty_body?(body) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 51
def empty_body?(body)
  !body || body_length(body).zero?
end
length_in_modifier_form(node, cond, body_length) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 34
def length_in_modifier_form(node, cond, body_length)
  indentation = node.loc.keyword.column
  kw_length = node.loc.keyword.size
  cond_length = cond.source_range.size
  space = 1
  indentation + body_length + space + kw_length + space + cond_length
end
line_count(node) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 47
def line_count(node)
  node.source.lines.grep(/\S/).size
end
max_line_length() click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 42
def max_line_length
  cop_config['MaxLineLength'] ||
    config.for_cop('Metrics/LineLength')['Max']
end
modifier_fits_on_single_line?(node) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 27
def modifier_fits_on_single_line?(node)
  modifier_length = length_in_modifier_form(node, node.condition,
                                            body_length(node.body))

  modifier_length <= max_line_length
end
non_eligible_body?(body) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 19
def non_eligible_body?(body)
  empty_body?(body) || body.begin_type? || commented?(body.source_range)
end
non_eligible_condition?(condition) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 23
def non_eligible_condition?(condition)
  condition.each_node.any?(&:lvasgn_type?)
end
non_eligible_node?(node) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 14
def non_eligible_node?(node)
  line_count(node) > 3 ||
    !node.modifier_form? && commented?(node.loc.end)
end
single_line_as_modifier?(node) click to toggle source
# File lib/rubocop/cop/mixin/statement_modifier.rb, line 6
def single_line_as_modifier?(node)
  return false if non_eligible_node?(node) ||
                  non_eligible_body?(node.body) ||
                  non_eligible_condition?(node.condition)

  modifier_fits_on_single_line?(node)
end