Class: RuboCop::Cop::Style::Encoding

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/encoding.rb

Overview

This cop checks ensures source files have no utf-8 encoding comments.

Examples:

# bad
# encoding: UTF-8
# coding: UTF-8
# -*- coding: UTF-8 -*-

Constant Summary collapse

MSG_UNNECESSARY =
'Unnecessary utf-8 encoding comment.'
ENCODING_PATTERN =
/#.*coding\s?[:=]\s?(?:UTF|utf)-8/.freeze
SHEBANG =
'#!'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object


29
30
31
32
33
34
# File 'lib/rubocop/cop/style/encoding.rb', line 29

def autocorrect(range)
  lambda do |corrector|
    corrector.remove(range_with_surrounding_space(range: range,
                                                  side: :right))
  end
end

#investigate(processed_source) ⇒ Object


19
20
21
22
23
24
25
26
27
# File 'lib/rubocop/cop/style/encoding.rb', line 19

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, location: range, message: @message)
end