class RuboCop::Cop::Lint::RedundantRequireStatement
Checks for unnecessary ‘require` statement.
The following features are unnecessary ‘require` statement because they are already loaded. e.g. Ruby 2.2:
ruby -ve 'p $LOADED_FEATURES.reject { |feature| %r|/| =~ feature }' ruby 2.2.8p477 (2017-09-14 revision 59906) [x86_64-darwin13] ["enumerator.so", "rational.so", "complex.so", "thread.rb"]
Below are the features that each ‘TargetRubyVersion` targets.
* 2.0+ ... `enumerator` * 2.1+ ... `thread` * 2.2+ ... Add `rational` and `complex` above * 2.5+ ... Add `pp` above * 2.7+ ... Add `ruby2_keywords` above * 3.1+ ... Add `fiber` above * 3.2+ ... `set`
This cop target those features.
@safety
This cop's autocorrection is unsafe because if `require 'pp'` is removed from one file, `NameError` can be encountered when another file uses `PP.pp`.
@example
# bad require 'unloaded_feature' require 'thread' # good require 'unloaded_feature'
Constants
- MSG
- PRETTY_PRINT_METHODS
- RESTRICT_ON_SEND
- RUBY_22_LOADED_FEATURES
Public Instance Methods
on_send(node)
click to toggle source
# File lib/rubocop/cop/lint/redundant_require_statement.rb, line 61 def on_send(node) return unless redundant_require_statement?(node) add_offense(node) do |corrector| if node.parent.respond_to?(:modifier_form?) && node.parent.modifier_form? corrector.insert_after(node.parent, "\nend") range = range_with_surrounding_space(node.source_range, side: :right) else range = range_by_whole_lines(node.source_range, include_final_newline: true) end corrector.remove(range) end end
Private Instance Methods
need_to_require_pp?()
click to toggle source
rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# File lib/rubocop/cop/lint/redundant_require_statement.rb, line 91 def need_to_require_pp? processed_source.ast.each_descendant(:send).any? do |node| pp_const?(node.receiver) || PRETTY_PRINT_METHODS.include?(node.method_name) end end
redundant_feature?(feature_name)
click to toggle source
rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# File lib/rubocop/cop/lint/redundant_require_statement.rb, line 80 def redundant_feature?(feature_name) feature_name == 'enumerator' || (target_ruby_version >= 2.1 && feature_name == 'thread') || (target_ruby_version >= 2.2 && RUBY_22_LOADED_FEATURES.include?(feature_name)) || (target_ruby_version >= 2.5 && feature_name == 'pp' && !need_to_require_pp?) || (target_ruby_version >= 2.7 && feature_name == 'ruby2_keywords') || (target_ruby_version >= 3.1 && feature_name == 'fiber') || (target_ruby_version >= 3.2 && feature_name == 'set') end