Class: RuboCop::Cop::Style::RedundantFileExtensionInRequire

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/style/redundant_file_extension_in_require.rb

Overview

This cop checks for the presence of superfluous ‘.rb` extension in the filename provided to `require` and `require_relative`.

Note: If the extension is omitted, Ruby tries adding ‘.rb’, ‘.so’,

and so on to the name until found. If the file named cannot be found,
a `LoadError` will be raised.
There is an edge case where `foo.so` file is loaded instead of a `LoadError`
if `foo.so` file exists when `require 'foo.rb'` will be changed to `require 'foo'`,
but that seems harmless.

Examples:

# bad
require 'foo.rb'
require_relative '../foo.rb'

# good
require 'foo'
require 'foo.so'
require_relative '../foo'
require_relative '../foo.so'

Constant Summary collapse

MSG = 
'Redundant `.rb` file extension detected.'
RESTRICT_ON_SEND = 
%i[require require_relative].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

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_new_investigation, #on_other_file, #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?, #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_send(node) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/rubocop/cop/style/redundant_file_extension_in_require.rb', line 38

def on_send(node)
  require_call?(node) do |name_node|
    return unless name_node.value.end_with?('.rb')

    add_offense(name_node) do |corrector|
      correction = name_node.value.sub(/\.rb\z/, '')

      corrector.replace(name_node, "'#{correction}'")
    end
  end
end

#require_call?(node) ⇒ Object 



34
35
36
 
# File 'lib/rubocop/cop/style/redundant_file_extension_in_require.rb', line 34

def_node_matcher :require_call?, <<~PATTERN
  (send nil? {:require :require_relative} $str_type?)
PATTERN