123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::Cop::StatementModifier

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Style::GuardClause, Style::IfUnlessModifier, Style::IfUnlessModifierOfIfUnless, Style::MultilineIfModifier, Style::WhileUntilModifier
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, AllowedPattern, LineLengthHelp, Alignment
Defined in: lib/rubocop/cop/mixin/statement_modifier.rb

Overview

Common functionality for modifier cops.

Constant Summary

Alignment - Included

SPACE

Instance Attribute Summary

LineLengthHelp - Included

#allow_cop_directives?, #allow_qualified_name?, #allow_rbs_inline_annotation?, #allow_uri?

Alignment - Included

#column_delta

Instance Method Summary

AllowedPattern - Included

#allowed_line?, #allowed_pattern_regexps, #allowed_patterns, #cop_config_deprecated_methods_values, #cop_config_patterns_values, #ignored_line?, #matches_allowed_pattern?, #matches_ignored_pattern?

LineLengthHelp - Included

#allowed_position?, #directive_on_source_line?, #extend_end_position, #find_excessive_range, #indentation_difference, #line_length, #line_length_without_directive, #match_qualified_names, #match_uris, #qualified_name_regexp, #rbs_inline_annotation_on_source_line?, #tab_indentation_width, #uri_regexp, #valid_uri?

Alignment - Included

#check_alignment, #configured_indentation_width, #display_column, #each_bad_alignment, #end_of_line_comment, #indentation, #offset, #register_offense, #within?

Instance Method Details

#acceptable_line_length?(line, line_number) ⇒ Boolean (private)

Rather than comparing the rendered modifier form against the bare maximum, ask the question Layout/LineLength would: a line the user’s configuration exempts (Layout/LineLength disabled at that line, an allowed pattern, an allowed cop directive, an allowed URI) fits by definition. This keeps every modifier cop consistent with Layout/LineLength instead of each reimplementing part of its policy.

[ GitHub ] 

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 55



def acceptable_line_length?(line, line_number)
  return true unless max_line_length
  return true if line_length(line) <= max_line_length
  return true unless line_length_enabled_at_line?(line_number)
  return true if matches_allowed_pattern?(line)

  if allow_cop_directives? && directive_on_source_line?(line_number - 1)
    return line_length_without_directive(line) <= max_line_length
  end

  allowed_by_uri?(line)
end


  








  

    #allowed_by_uri?(line)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 68



def allowed_by_uri?(line)
  return false unless allow_uri?

  uri_range = find_excessive_range(line, :uri)
  !uri_range.nil? && allowed_position?(line, uri_range)
end


  








  

    #allowed_patterns   (private)
  



  

    


`Layout/LineLength’s allowed patterns, so a modifier line that the
user has configured that cop to accept is not flagged for length here.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 81



def allowed_patterns
  line_length_config = config.for_cop('Layout/LineLength')
  line_length_config['AllowedPatterns'] || line_length_config['IgnoredPatterns'] || []
end


  








  

    #code_after(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 121



def code_after(node)
  end_element = node.loc.end
  code = end_element.source_line[end_element.last_column..]
  code unless code.empty?
end


  








  

    #comment_disables_cop?(comment)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 139



def comment_disables_cop?(comment)
  regexp_pattern = "# rubocop : (disable|todo) ([^,],)* (all|#{cop_name})"
  Regexp.new(regexp_pattern.gsub(' ', '\s*')).match?(comment)
end


  








  

    #first_line_comment(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 113



def first_line_comment(node)
  comment = processed_source.comment_at_line(node.first_line)
  return unless comment

  comment_source = comment.source
  comment_source unless comment_disables_cop?(comment_source)
end


  








  

    #if_body_source(if_body)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 93



def if_body_source(if_body)
  if if_body.call_type? && !if_body.method?(:[]=) && omitted_value_in_last_hash_arg?(if_body)
    "#{method_source(if_body)}(#{if_body.arguments.map(&:source).join(', ')})"
  else
    if_body.source
  end
end


  








  

    #line_in_modifier_form(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 42



def line_in_modifier_form(node)
  keyword_element = node.loc.keyword
  code_before = keyword_element.source_line[0...keyword_element.column]

  "#{code_before}#{to_modifier_form(node)}#{code_after(node)}"
end


  








  

    #line_length_enabled_at_line?(line)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 75



def line_length_enabled_at_line?(line)
  processed_source.comment_config.cop_enabled_at_line?('Layout/LineLength', line)
end


  








  

    #method_source(if_body)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 107



def method_source(if_body)
  end_range = if_body.implicit_call? ? if_body.loc.dot.end : if_body.loc.selector

  if_body.source_range.begin.join(end_range).source
end


  








  

    #modifier_fits_on_single_line?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 38



def modifier_fits_on_single_line?(node)
  acceptable_line_length?(line_in_modifier_form(node), node.first_line)
end


  








  

    #non_eligible_body?(body)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 27



def non_eligible_body?(body)
  body.nil? ||
    body.empty_source? ||
    body.begin_type? ||
    processed_source.contains_comment?(body.source_range)
end


  








  

    #non_eligible_condition?(condition)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 34



def non_eligible_condition?(condition)
  condition.each_node.any?(&:lvasgn_type?)
end


  








  

    #non_eligible_node?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 20



def non_eligible_node?(node)
  node.modifier_form? ||
    node.nonempty_line_count > 3 ||
    processed_source.line_with_comment?(node.loc.last_line) ||
    (first_line_comment(node) && code_after(node))
end


  








  

    #omitted_value_in_last_hash_arg?(if_body)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 101



def omitted_value_in_last_hash_arg?(if_body)
  return false unless (last_argument = if_body.last_argument)

  last_argument.hash_type? && last_argument.pairs.last&.value_omission?
end


  








  

    #parenthesize?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 127



def parenthesize?(node)
  # Parenthesize corrected expression if changing to modifier-if form
  # would change the meaning of the parent expression
  # (due to the low operator precedence of modifier-if)
  parent = node.parent
  return false if parent.nil?
  return true if parent.assignment? || parent.operator_keyword?
  return true if %i[array pair].include?(parent.type)

  node.parent.send_type?
end


  








  

    #single_line_as_modifier?(node)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 12



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


  








  

    #to_modifier_form(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/statement_modifier.rb', line 86



def to_modifier_form(node)
  body = if_body_source(node.body)
  expression = [body, node.keyword, node.condition.source].compact.join(' ')
  parenthesized = parenthesize?(node) ? "(#{expression})" : expression
  [parenthesized, first_line_comment(node)].compact.join(' ')
end