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

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.'.freeze
MSG_UNNECESSARY = 
'Unnecessary utf-8 encoding comment.'.freeze
ENCODING_PATTERN = 
/#.*coding\s?[:=]\s?(?:UTF|utf)-8/
AUTO_CORRECT_ENCODING_COMMENT = 
'AutoCorrectEncodingComment'.freeze
SHEBANG = 
'#!'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods included from ConfigurableEnforcedStyle

#alternative_style, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #parameter_name, #style, #style_detected, #supported_styles, #unexpected_style_detected

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #initialize, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, ternary_op?, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Instance Method Details

#autocorrect(range) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/rubocop/cop/style/encoding.rb', line 34

def autocorrect(range)
  if @message == MSG_MISSING
    encoding = cop_config[AUTO_CORRECT_ENCODING_COMMENT]
    if encoding && encoding =~ ENCODING_PATTERN
      lambda do |corrector|
        corrector.insert_before(range, "#{encoding}\n")
      end
    else
      raise "#{encoding} does not match #{ENCODING_PATTERN}"
    end
  else
    # Need to remove unnecessary encoding comment
    lambda do |corrector|
      corrector.remove(range_with_surrounding_space(range, :right))
    end
  end
end

#investigate(processed_source) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/rubocop/cop/style/encoding.rb', line 24

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