Class: RuboCop::Cop::Style::Encoding
- 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. Setting this check to “always” and “when_needed” 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 three 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 never - enforce no 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::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, 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, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_ruby_version
Methods included from AST::Sexp
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 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?, compatible_external_encoding_for?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, hard_to_type?, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, numeric_range_size, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_with_surrounding_comma, range_with_surrounding_space, same_line?, source_range, strip_quotes, stripped_source_upto, to_string_literal, to_supported_styles, to_symbol_literal, within_node?
Methods included from PathUtil
absolute?, match_path?, relative_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(range) ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/rubocop/cop/style/encoding.rb', line 35 def autocorrect(range) if @message == MSG_MISSING raise unless matching_encoding? lambda do |corrector| corrector.insert_before(range, "#{encoding}\n") 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
25 26 27 28 29 30 31 32 33 |
# File 'lib/rubocop/cop/style/encoding.rb', line 25 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 |