class RuboCop::Cop::Layout::EndOfLine

Checks for Windows-style line endings in the source code.

@example 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.

@example 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 platforms.

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

@example 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 platforms.

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

Constants

MSG_DETECTED
MSG_MISSING

Public Instance Methods

offense_message(line) click to toggle source
# File lib/rubocop/cop/layout/end_of_line.rb, line 71
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.end_with?("\r", "\r\n")
  else MSG_MISSING unless line.end_with?("\r\n")
  end
end
on_new_investigation() click to toggle source
# File lib/rubocop/cop/layout/end_of_line.rb, line 47
def on_new_investigation
  last_line = last_line(processed_source)

  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(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
unimportant_missing_cr?(index, last_line, line) click to toggle source

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

# File lib/rubocop/cop/layout/end_of_line.rb, line 67
def unimportant_missing_cr?(index, last_line, line)
  style == :crlf && index == last_line - 1 && !line.end_with?("\n")
end

Private Instance Methods

last_line(processed_source) click to toggle source
# File lib/rubocop/cop/layout/end_of_line.rb, line 85
def last_line(processed_source)
  last_token = processed_source.tokens.last
  last_token ? last_token.line : processed_source.lines.length
end