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

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

Overview

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 style:

when_needed - only enforce an encoding comment if there are non ASCII characters, otherwise report an offense always - enforce encoding comment in all files

Constant Summary collapse

MSG_MISSING = 
'Missing utf-8 encoding comment.'
MSG_UNNECESSARY = 
'Unnecessary utf-8 encoding comment.'

Constants included from Util

Util::ASGN_NODES, Util::EQUALS_ASGN_NODES, Util::OPERATOR_METHODS, Util::PROC_NEW_NODE, Util::SHORTHAND_ASGN_NODES

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #both_styles_detected, #correct_style_detected, #opposite_style_detected, #parameter_name, #style, #unrecognized_style_detected

Methods inherited from Cop

#add_offense, all, #autocorrect?, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, cop_name_with_namespace, cop_type, #debug?, #display_cop_names?, inherited, #initialize, #join_force?, lint?, #message, non_rails, qualified_cop_name, rails?, #relevant_file?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, command?, comment_line?, const_name, first_part_of_call_chain, lambda?, lambda_or_proc?, line_range, numeric_range_size, on_node, operator?, parentheses?, proc?, range_with_surrounding_space, source_range, strip_quotes, within_node?

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object 



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

def investigate(processed_source)
  return if processed_source.buffer.source.empty?

  line_number = encoding_line_number(processed_source)
  message = offense(processed_source, line_number)

  return unless message

  range = source_range(processed_source.buffer, line_number + 1, 0)
  add_offense(nil, range, message)
end