Class: RuboCop::Cop::Layout::EndOfLine

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableEnforcedStyle
Defined in:
lib/rubocop/cop/layout/end_of_line.rb

Overview

This cop checks for Windows-style line endings in the source code.

Constant Summary collapse

MSG_DETECTED = 
'Carriage return character detected.'.freeze
MSG_MISSING = 
'Carriage return character missing.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, precede?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, find_file_upwards, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#investigate(processed_source) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 13

def investigate(processed_source)
  last_token = processed_source.tokens.last
  last_line =
    last_token ? last_token.line : processed_source.lines.length

  processed_source.raw_source.each_line.with_index do |line, index|
    break if index >= last_line
    msg = offense_message(line)
    next unless msg
    next if unimportant_missing_cr?(index, last_line, line)

    range =
      source_range(processed_source.buffer, index + 1, 0, line.length)
    add_offense(nil, location: range, message: msg)
    # Usually there will be carriage return characters on all or none
    # of the lines in a file, so we report only one offense.
    break
  end
end

#offense_message(line) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 38

def offense_message(line)
  effective_style = if style == :native
                      Platform.windows? ? :crlf : :lf
                    else
                      style
                    end
  case effective_style
  when :lf then MSG_DETECTED if line =~ /\r$/
  else MSG_MISSING if line !~ /\r$/
  end
end

#unimportant_missing_cr?(index, last_line, line) ⇒ Boolean

If there is no LF on the last line, we don’t care if there’s no CR.

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 34

def unimportant_missing_cr?(index, last_line, line)
  style == :crlf && index == last_line - 1 && line !~ /\n$/
end