Sha256: cd56f6e04c7d3276abc3ad56a59125ea105c0dba2058550764a1bbef0341be5e
Contents?: true
Size: 1.83 KB
Versions: 10
Compression:
Stored size: 1.83 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# 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.
#
# @example
# # bad
# require 'foo.rb'
# require_relative '../foo.rb'
#
# # good
# require 'foo'
# require 'foo.so'
# require_relative '../foo'
# require_relative '../foo.so'
#
class RedundantFileExtensionInRequire < Base
include RangeHelp
extend AutoCorrector
MSG = 'Redundant `.rb` file extension detected.'
RESTRICT_ON_SEND = %i[require require_relative].freeze
# @!method require_call?(node)
def_node_matcher :require_call?, <<~PATTERN
(send nil? {:require :require_relative} $str_type?)
PATTERN
def on_send(node)
require_call?(node) do |name_node|
return unless name_node.value.end_with?('.rb')
extension_range = extension_range(name_node)
add_offense(extension_range) do |corrector|
corrector.remove(extension_range)
end
end
end
private
def extension_range(name_node)
end_of_path_string = name_node.source_range.end_pos
range_between(end_of_path_string - 4, end_of_path_string - 1)
end
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems