Class: RuboCop::Cop::Lint::OrderedMagicComments
- Extended by:
- AutoCorrector
- 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.'
Constants included from FrozenStringLiteral
FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED, FrozenStringLiteral::FROZEN_STRING_LITERAL_TYPES
Constants inherited from Base
Instance Attribute Summary
Attributes inherited from Base
Instance Method Summary collapse
Methods included from AutoCorrector
Methods included from FrozenStringLiteral
frozen_string_literal_comment_exists?
Methods inherited from Base
#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version
Methods included from ExcludeLimit
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#on_new_investigation ⇒ Object
37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# File 'lib/rubocop/cop/lint/ordered_magic_comments.rb', line 37 def on_new_investigation 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) do |corrector| autocorrect(corrector, encoding_line, frozen_string_literal_line) end end |