class RuboCop::Cop::Style::Encoding

This cop checks whether the source file has a utf-8 encoding comment or not. This check makes sense only for code that should support Ruby 1.9, since in 2.0+ utf-8 is the default source file encoding. There are two styles:

when_needed - only enforce an encoding comment if there are non ASCII

characters, otherwise report an offense

always - enforce encoding comment in all files

Constants

AUTO_CORRECT_ENCODING_COMMENT
ENCODING_PATTERN
MSG_MISSING
MSG_UNNECESSARY
SHEBANG

Public Instance Methods

autocorrect(range) click to toggle source
# File lib/rubocop/cop/style/encoding.rb, line 33
def autocorrect(range)
  if @message == MSG_MISSING
    encoding = cop_config[AUTO_CORRECT_ENCODING_COMMENT]
    if encoding && encoding =~ ENCODING_PATTERN
      lambda do |corrector|
        corrector.insert_before(range, "#{encoding}\n")
      end
    else
      raise "#{encoding} does not match #{ENCODING_PATTERN}"
    end
  else
    # Need to remove unnecessary encoding comment
    lambda do |corrector|
      corrector.remove(range_with_surrounding_space(range, :right))
    end
  end
end
investigate(processed_source) click to toggle source
# File lib/rubocop/cop/style/encoding.rb, line 23
def investigate(processed_source)
  return if processed_source.buffer.source.empty?

  line_number = encoding_line_number(processed_source)
  return unless (@message = offense(processed_source, line_number))

  range = processed_source.buffer.line_range(line_number + 1)
  add_offense(range, range, @message)
end

Private Instance Methods

encoding_line_number(processed_source) click to toggle source
# File lib/rubocop/cop/style/encoding.rb, line 66
def encoding_line_number(processed_source)
  line_number = 0
  line_number += 1 if processed_source[line_number].start_with?(SHEBANG)
  line_number
end
offense(processed_source, line_number) click to toggle source
# File lib/rubocop/cop/style/encoding.rb, line 53
def offense(processed_source, line_number)
  line = processed_source[line_number]
  encoding_present = line =~ ENCODING_PATTERN
  ascii_only = processed_source.buffer.source.ascii_only?
  always_encode = style == :always

  if !encoding_present && (always_encode || !ascii_only)
    MSG_MISSING
  elsif !always_encode && ascii_only && encoding_present
    MSG_UNNECESSARY
  end
end