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

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

Overview

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

Examples:

EnforcedStyle: native (default)

# The `native` style means that CR+LF (Carriage Return + Line Feed) is
# enforced on Windows, and LF is enforced on other platforms.

# bad
puts 'Hello' # Return character is LF on Windows.
puts 'Hello' # Return character is CR+LF on other than Windows.

# good
puts 'Hello' # Return character is CR+LF on Windows.
puts 'Hello' # Return character is LF on other than Windows.

EnforcedStyle: lf

# The `lf` style means that LF (Line Feed) is enforced on
# all platforms.

# bad
puts 'Hello' # Return character is CR+LF on all platfoms.

# good
puts 'Hello' # Return character is LF on all platfoms.

EnforcedStyle: crlf

# The `crlf` style means that CR+LF (Carriage Return + Line Feed) is
# enforced on all platforms.

# bad
puts 'Hello' # Return character is LF on all platfoms.

# good
puts 'Hello' # Return character is CR+LF on all platfoms.

Constant Summary collapse

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

Constants included from Util

Util::LITERAL_REGEX

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 NodePattern::Macros

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

Methods included from AST::Sexp

#s

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?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, 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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 47

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



73
74
75
76
77
78
79
80
81
82
83
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 73

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)


69
70
71
# File 'lib/rubocop/cop/layout/end_of_line.rb', line 69

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