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

Inherits:

Base

• Object
• Base
• RuboCop::Cop::Style::Encoding

Extended by:

AutoCorrector

Includes:

RangeHelp

Defined in:

lib/rubocop/cop/style/encoding.rb

Overview

Checks ensures source files have no utf-8 encoding comments.

Examples:

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

Constant Summary

MSG =

'Unnecessary utf-8 encoding comment.'

ENCODING_PATTERN =

/#.*coding\s?[:=]\s?(?:UTF|utf)-8/.freeze

SHEBANG =

'#!'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary

• #on_new_investigation ⇒ Object

Methods included from AutoCorrector

support_autocorrect?

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

#on_new_investigation ⇒ Object

# File 'lib/rubocop/cop/style/encoding.rb', line 20

def on_new_investigation
  return if processed_source.buffer.source.empty?

  comments.each do |line_number, comment|
    next unless offense?(comment)

    register_offense(line_number, comment)
  end
end