Class: RuboCop::Cop::Lint::OrderedMagicComments
- Includes:
- FrozenStringLiteral
- Defined in:
- lib/rubocop/cop/lint/ordered_magic_comments.rb
Overview
Checks the proper ordering of magic comments and whether a magic comment is not placed before a shebang.
Constant Summary collapse
- MSG =
'The encoding magic comment should precede all other ' \ 'magic comments.'.freeze
Constants included from FrozenStringLiteral
FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED, FrozenStringLiteral::FROZEN_STRING_LITERAL_TYPES
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
Methods included from FrozenStringLiteral
frozen_string_literal_comment_exists?
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, 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_rails_version, #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?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(_node) ⇒ Object
49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/rubocop/cop/lint/ordered_magic_comments.rb', line 49 def autocorrect(_node) encoding_line, frozen_string_literal_line = magic_comment_lines range1 = processed_source.buffer.line_range(encoding_line + 1) range2 = processed_source.buffer.line_range(frozen_string_literal_line + 1) lambda do |corrector| corrector.replace(range1, range2.source) corrector.replace(range2, range1.source) end end |
#investigate(processed_source) ⇒ Object
36 37 38 39 40 41 42 43 44 45 46 47 |
# File 'lib/rubocop/cop/lint/ordered_magic_comments.rb', line 36 def investigate(processed_source) return if processed_source.buffer.source.empty? encoding_line, frozen_string_literal_line = magic_comment_lines return unless encoding_line && frozen_string_literal_line return if encoding_line < frozen_string_literal_line range = processed_source.buffer.line_range(encoding_line + 1) add_offense(range, location: range) end |