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

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

Overview

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

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

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.

Constant Summary collapse

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

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #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_configured?, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#offense_message(line) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# 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 ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# 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) ⇒ Boolean

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

Returns:

  • (Boolean) 


67
68
69
 
# 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