class RuboCop::Cop::Metrics::LineLength
This cop checks the length of lines in the source code. The maximum length is configurable.
Constants
- MSG
Public Instance Methods
investigate(processed_source)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 15 def investigate(processed_source) heredocs = extract_heredocs(processed_source.ast) if allow_heredoc? processed_source.lines.each_with_index do |line, index| check_line(line, index, heredocs) end end
Private Instance Methods
allow_heredoc?()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 67 def allow_heredoc? allowed_heredoc end
allow_uri?()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 92 def allow_uri? cop_config['AllowURI'] end
allowed_heredoc()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 71 def allowed_heredoc cop_config['AllowHeredoc'] end
allowed_uri_position?(line, uri_range)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 100 def allowed_uri_position?(line, uri_range) uri_range.begin < max && uri_range.end == line.length end
check_directive_line(line, index)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 131 def check_directive_line(line, index) return if line_length_without_directive(line) <= max range = max..(line_length_without_directive(line) - 1) register_offense( source_range( processed_source.buffer, index + 1, range ), line ) end
check_line(line, index, heredocs)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 24 def check_line(line, index, heredocs) return if line.length <= max return if ignored_line?(line, index, heredocs) if ignore_cop_directives? && directive_on_source_line?(index) return check_directive_line(line, index) end return check_uri_line(line, index) if allow_uri? register_offense( source_range(processed_source.buffer, index + 1, 0...line.length), line ) end
check_uri_line(line, index)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 161 def check_uri_line(line, index) uri_range = find_excessive_uri_range(line) return if uri_range && allowed_uri_position?(line, uri_range) register_offense(excess_range(uri_range, line, index), line) end
directive_on_source_line?(index)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 145 def directive_on_source_line?(index) source_line_number = index + processed_source.buffer.first_line comment = processed_source .comments .detect { |e| e.location.line == source_line_number } return false unless comment comment.text.match(CommentConfig::COMMENT_DIRECTIVE_REGEXP) end
excess_range(uri_range, line, index)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 52 def excess_range(uri_range, line, index) excessive_position = if uri_range && uri_range.begin < max uri_range.end else max end source_range(processed_source.buffer, index + 1, excessive_position...(line.length)) end
extract_heredocs(ast)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 75 def extract_heredocs(ast) return [] unless ast ast.each_node.with_object([]) do |node, heredocs| next unless node.location.is_a?(Parser::Source::Map::Heredoc) body = node.location.heredoc_body delimiter = node.location.heredoc_end.source.strip heredocs << [body.first_line...body.last_line, delimiter] end end
find_excessive_uri_range(line)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 104 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) return nil if begin_position < max && end_position < max begin_position...end_position end
ignore_cop_directives?()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 96 def ignore_cop_directives? cop_config['IgnoreCopDirectives'] end
ignored_line?(line, index, heredocs)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 39 def ignored_line?(line, index, heredocs) matches_ignored_pattern?(line) || heredocs && line_in_whitelisted_heredoc?(heredocs, index.succ) end
line_in_whitelisted_heredoc?(heredocs, line_number)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 85 def line_in_whitelisted_heredoc?(heredocs, line_number) heredocs.any? do |range, delimiter| range.cover?(line_number) && (allowed_heredoc == true || allowed_heredoc.include?(delimiter)) end end
line_length_without_directive(line)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 156 def line_length_without_directive(line) before_comment, = line.split(CommentConfig::COMMENT_DIRECTIVE_REGEXP) before_comment.rstrip.length end
match_uris(string)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 112 def match_uris(string) matches = [] string.scan(uri_regexp) do matches << $LAST_MATCH_INFO if valid_uri?($LAST_MATCH_INFO[0]) end matches end
max()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 63 def max cop_config['Max'] end
register_offense(loc, line)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 44 def register_offense(loc, line) message = format(MSG, line.length, max) add_offense(nil, location: loc, message: message) do self.max = line.length end end
uri_regexp()
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 127 def uri_regexp @regexp ||= URI::DEFAULT_PARSER.make_regexp(cop_config['URISchemes']) end
valid_uri?(uri_ish_string)
click to toggle source
# File lib/rubocop/cop/metrics/line_length.rb, line 120 def valid_uri?(uri_ish_string) URI.parse(uri_ish_string) true rescue URI::InvalidURIError, NoMethodError false end