123456789_123456789_123456789_123456789_123456789_

Module: RuboCop::Cop::LineLengthHelp

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

Overview

Help methods for determining if a line is too long.

Constant Summary

Alignment - Included

SPACE

Instance Attribute Summary

Alignment - Included

#column_delta

Instance Method Summary

Alignment - Included

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

Instance Attribute Details

#allow_uri? ⇒ Boolean (readonly, private)

[ GitHub ] 

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 24



def allow_uri?
  config.for_cop('Layout/LineLength')['AllowURI']
end


  








  

    #ignore_cop_directives?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 11



def ignore_cop_directives?
  config.for_cop('Layout/LineLength')['IgnoreCopDirectives']
end


  







Instance Method Details



  

    #allowed_uri_position?(line, uri_range)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 28



def allowed_uri_position?(line, uri_range)
  uri_range.begin < max_line_length && uri_range.end == line_length(line)
end


  








  

    #directive_on_source_line?(line_index)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 15



def directive_on_source_line?(line_index)
  source_line_number = line_index + processed_source.buffer.first_line
  comment = processed_source.comment_at_line(source_line_number)

  return false unless comment

  !!DirectiveComment.new(comment).match_captures
end


  








  

    #extend_uri_end_position(line, end_position)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 72



def extend_uri_end_position(line, end_position)
  # Extend the end position YARD comments with linked URLs of the form {<uri> <title>}
  if line&.match(/{(\s|\S)*}$/)
    match = line[end_position..line_length(line)]&.match(/(\s|\S)*}/)
    end_position += match.offset(0).last
  end

  # Extend the end position until the start of the next word, if any.
  # This allows for URIs that are wrapped in quotes or parens to be handled properly
  # while not allowing additional words to be added after the URL.
  if (match = line[end_position..line_length(line)]&.match(/^\S+(?=\s|$)/))
    end_position += match.offset(0).last
  end
  end_position
end


  








  

    #find_excessive_uri_range(line)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 36



def find_excessive_uri_range(line)
  last_uri_match = match_uris(line).last
  return nil unless last_uri_match

  begin_position, end_position = last_uri_match.offset(0).map do |pos|
    pos + indentation_difference(line)
  end

  end_position = extend_uri_end_position(line, end_position)

  return nil if begin_position < max_line_length && end_position < max_line_length

  begin_position...end_position
end


  








  

    #indentation_difference(line)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 59



def indentation_difference(line)
  return 0 unless tab_indentation_width

  index =
    if line.match?(/^[^\t]/)
      0
    else
      line.index(/[^\t]/) || 0
    end

  index * (tab_indentation_width - 1)
end


  








  

    #line_length(line)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 32



def line_length(line)
  line.length + indentation_difference(line)
end


  








  

    #line_length_without_directive(line)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 105



def line_length_without_directive(line)
  DirectiveComment.before_comment(line).rstrip.length
end


  








  

    #match_uris(string)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 51



def match_uris(string)
  matches = []
  string.scan(uri_regexp) do
    matches << $LAST_MATCH_INFO if valid_uri?($LAST_MATCH_INFO[0])
  end
  matches
end


  








  

    #tab_indentation_width   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 88



def tab_indentation_width
  config.for_cop('Layout/IndentationStyle')['IndentationWidth'] ||
    configured_indentation_width
end


  








  

    #uri_regexp   (private)
  

  [ GitHub ]


  

  


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



def uri_regexp
  @uri_regexp ||=
    URI::DEFAULT_PARSER.make_regexp(config.for_cop('Layout/LineLength')['URISchemes'])
end


  








  

    #valid_uri?(uri_ish_string)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/cop/mixin/line_length_help.rb', line 98



def valid_uri?(uri_ish_string)
  URI.parse(uri_ish_string)
  true
rescue URI::InvalidURIError, NoMethodError
  false
end