class RuboCop::Cop::Lint::OrderedMagicComments

Checks the proper ordering of magic comments and whether a magic comment is not placed before a shebang.

@safety

This cop's autocorrection is unsafe because file encoding may change.

@example

# bad

# frozen_string_literal: true
# encoding: ascii
p [''.frozen?, ''.encoding] #=> [true, #<Encoding:UTF-8>]

# good

# encoding: ascii
# frozen_string_literal: true
p [''.frozen?, ''.encoding] #=> [true, #<Encoding:US-ASCII>]

# good

#!/usr/bin/env ruby
# encoding: ascii
# frozen_string_literal: true
p [''.frozen?, ''.encoding] #=> [true, #<Encoding:US-ASCII>]

Constants

MSG

Public Instance Methods

on_new_investigation() click to toggle source
# File lib/rubocop/cop/lint/ordered_magic_comments.rb, line 39
def on_new_investigation
  return if processed_source.buffer.source.empty?

  encoding_line, frozen_string_literal_line = magic_comment_lines

  return unless encoding_line && frozen_string_literal_line
  return if encoding_line < frozen_string_literal_line

  range = processed_source.buffer.line_range(encoding_line + 1)

  add_offense(range) do |corrector|
    autocorrect(corrector, encoding_line, frozen_string_literal_line)
  end
end

Private Instance Methods

autocorrect(corrector, encoding_line, frozen_string_literal_line) click to toggle source
# File lib/rubocop/cop/lint/ordered_magic_comments.rb, line 56
def autocorrect(corrector, encoding_line, frozen_string_literal_line)
  range1 = processed_source.buffer.line_range(encoding_line + 1)
  range2 = processed_source.buffer.line_range(frozen_string_literal_line + 1)

  corrector.replace(range1, range2.source)
  corrector.replace(range2, range1.source)
end
magic_comment_lines() click to toggle source
# File lib/rubocop/cop/lint/ordered_magic_comments.rb, line 64
def magic_comment_lines
  lines = [nil, nil]

  leading_magic_comments.each.with_index do |comment, index|
    if comment.encoding_specified?
      lines[0] = index
    elsif comment.frozen_string_literal_specified?
      lines[1] = index
    end

    return lines if lines[0] && lines[1]
  end

  lines
end