Class: Rubocop::Cop::Style::Encoding

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

Overview

This cop checks whether the source file has a utf-8 encoding comment. This check makes sense only in Ruby 1.9, since in 2.0+ utf-8 is the default source file encoding.

Constant Summary collapse

MSG = 
'Missing utf-8 encoding comment.'

Constants inherited from Cop

Cop::OPERATOR_METHODS

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offences, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offence, all, #autocorrect?, #convention, #cop_config, cop_name, #cop_name, cop_type, #debug?, #ignore_node, inherited, #initialize, lint?, #message, non_rails, rails?, style?, #support_autocorrect?, #warning

Constructor Details

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

Instance Method Details

#investigate(processed_source) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/rubocop/cop/style/encoding.rb', line 13

def investigate(processed_source)
  unless RUBY_VERSION >= '2.0.0'
    line_number = 0
    line_number += 1 if processed_source[line_number] =~ /^#!/
    line = processed_source[line_number]
    unless line =~ /#.*coding\s?[:=]\s?(UTF|utf)-8/
      convention(nil,
                 source_range(processed_source.buffer,
                              processed_source[0...line_number],
                              0, 1),
                 MSG)
    end
  end
end