class RuboCop::Cop::Lint::OrderedMagicComments
p [”.frozen?, ”.encoding] #=> [true, #<Encoding:US-ASCII>]
# frozen_string_literal: true
# encoding: ascii
#!/usr/bin/env ruby
# good
p [”.frozen?, ”.encoding] #=> [true, #<Encoding:US-ASCII>]
# frozen_string_literal: true
# encoding: ascii
# good
p [”.frozen?, ”.encoding] #=> [true, #<Encoding:UTF-8>]
# encoding: ascii
# frozen_string_literal: true
# bad
@example
a magic comment is not placed before a shebang.
Checks the proper ordering of magic comments and whether
def autocorrect(corrector, encoding_line, frozen_string_literal_line)
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
def magic_comment_lines
def magic_comment_lines lines = [nil, nil] 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
def magic_comments
def magic_comments leading_comment_lines.map { |line| MagicComment.parse(line) } end
def on_new_investigation
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