Class: RuboCop::Cop::Lint::DuplicateMagicComment

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
FrozenStringLiteral, RangeHelp
Defined in:
lib/rubocop/cop/lint/duplicate_magic_comment.rb

Overview

Checks for duplicated magic comments.

Examples:


# bad

# encoding: ascii
# encoding: ascii

# good

# encoding: ascii

# bad

# frozen_string_literal: true
# frozen_string_literal: true

# good

# frozen_string_literal: true

Constant Summary collapse

MSG =
'Duplicate magic comment detected.'

Constants included from FrozenStringLiteral

FrozenStringLiteral::FROZEN_STRING_LITERAL, FrozenStringLiteral::FROZEN_STRING_LITERAL_ENABLED

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from FrozenStringLiteral

frozen_string_literal_comment_exists?

Methods inherited from Base

#active_support_extensions_enabled?, #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, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#on_new_investigationObject


35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/rubocop/cop/lint/duplicate_magic_comment.rb', line 35

def on_new_investigation
  return if processed_source.buffer.source.empty?

  magic_comment_lines.each_value do |comment_lines|
    next if comment_lines.count <= 1

    comment_lines[1..].each do |comment_line|
      range = processed_source.buffer.line_range(comment_line + 1)

      register_offense(range)
    end
  end
end