lib/bundled_gems.rb

   1 # -*- frozen-string-literal: true -*-
   2
   3 # :stopdoc:
   4
   5 module Gem::BUNDLED_GEMS
   6   SINCE = {
   7     "rexml" => "3.0.0",
   8     "rss" => "3.0.0",
   9     "webrick" => "3.0.0",
  10     "matrix" => "3.1.0",
  11     "net-ftp" => "3.1.0",
  12     "net-imap" => "3.1.0",
  13     "net-pop" => "3.1.0",
  14     "net-smtp" => "3.1.0",
  15     "prime" => "3.1.0",
  16     "racc" => "3.3.0",
  17     "abbrev" => "3.4.0",
  18     "base64" => "3.4.0",
  19     "bigdecimal" => "3.4.0",
  20     "csv" => "3.4.0",
  21     "drb" => "3.4.0",
  22     "getoptlong" => "3.4.0",
  23     "mutex_m" => "3.4.0",
  24     "nkf" => "3.4.0",
  25     "observer" => "3.4.0",
  26     "resolv-replace" => "3.4.0",
  27     "rinda" => "3.4.0",
  28     "syslog" => "3.4.0",
  29     "ostruct" => "3.5.0",
  30     "pstore" => "3.5.0",
  31     "rdoc" => "3.5.0",
  32   }.freeze
  33
  34   EXACT = {
  35     "abbrev" => true,
  36     "base64" => true,
  37     "bigdecimal" => true,
  38     "csv" => true,
  39     "drb" => true,
  40     "getoptlong" => true,
  41     "mutex_m" => true,
  42     "nkf" => true, "kconv" => "nkf",
  43     "observer" => true,
  44     "resolv-replace" => true,
  45     "rinda" => true,
  46     "syslog" => true,
  47     "ostruct" => true,
  48     "pstore" => true,
  49     "rdoc" => true,
  50   }.freeze
  51
  52   PREFIXED = {
  53     "bigdecimal" => true,
  54     "csv" => true,
  55     "drb" => true,
  56     "rinda" => true,
  57     "syslog" => true,
  58   }.freeze
  59
  60   WARNED = {}                   # unfrozen
  61
  62   conf = ::RbConfig::CONFIG
  63   LIBDIR = (conf["rubylibdir"] + "/").freeze
  64   ARCHDIR = (conf["rubyarchdir"] + "/").freeze
  65   dlext = [conf["DLEXT"], "so"].uniq
  66   DLEXT = /\.#{Regexp.union(dlext)}\z/
  67   LIBEXT = /\.#{Regexp.union("rb", *dlext)}\z/
  68
  69   def self.replace_require(specs)
  70     return if [::Kernel.singleton_class, ::Kernel].any? {|klass| klass.respond_to?(:no_warning_require) }
  71
  72     spec_names = specs.to_a.each_with_object({}) {|spec, h| h[spec.name] = true }
  73
  74     [::Kernel.singleton_class, ::Kernel].each do |kernel_class|
  75       kernel_class.send(:alias_method, :no_warning_require, :require)
  76       kernel_class.send(:define_method, :require) do |name|
  77         if message = ::Gem::BUNDLED_GEMS.warning?(name, specs: spec_names) # rubocop:disable Style/HashSyntax
  78           warn message, :uplevel => 1
  79         end
  80         kernel_class.send(:no_warning_require, name)
  81       end
  82       if kernel_class == ::Kernel
  83         kernel_class.send(:private, :require)
  84       else
  85         kernel_class.send(:public, :require)
  86       end
  87     end
  88   end
  89
  90   def self.find_gem(path)
  91     if !path
  92       return
  93     elsif path.start_with?(ARCHDIR)
  94       n = path.delete_prefix(ARCHDIR).sub(DLEXT, "")
  95     elsif path.start_with?(LIBDIR)
  96       n = path.delete_prefix(LIBDIR).chomp(".rb")
  97     else
  98       return
  99     end
 100     EXACT[n] or PREFIXED[n = n[%r[\A[^/]+(?=/)]]] && n
 101   end
 102
 103   def self.warning?(name, specs: nil)
 104     # name can be a feature name or a file path with String or Pathname
 105     feature = File.path(name)
 106     # bootsnap expands `require "csv"` to `require "#{LIBDIR}/csv.rb"`,
 107     # and `require "syslog"` to `require "#{ARCHDIR}/syslog.so"`.
 108     name = feature.delete_prefix(ARCHDIR)
 109     name.delete_prefix!(LIBDIR)
 110     name.tr!("/", "-")
 111     name.sub!(LIBEXT, "")
 112     return if specs.include?(name)
 113     _t, path = $:.resolve_feature_path(feature)
 114     if gem = find_gem(path)
 115       return if specs.include?(gem)
 116       caller = caller_locations(3, 3)&.find {|c| c&.absolute_path}
 117       return if find_gem(caller&.absolute_path)
 118     elsif SINCE[name] && !path
 119       gem = true
 120     else
 121       return
 122     end
 123
 124     return if WARNED[name]
 125     WARNED[name] = true
 126     if gem == true
 127       gem = name
 128       "#{feature} was loaded from the standard library, but"
 129     elsif gem
 130       return if WARNED[gem]
 131       WARNED[gem] = true
 132       "#{feature} is found in #{gem}, which"
 133     else
 134       return
 135     end + build_message(gem)
 136   end
 137
 138   def self.build_message(gem)
 139     msg = " #{RUBY_VERSION < SINCE[gem] ? "will no longer be" : "is not"} part of the default gems since Ruby #{SINCE[gem]}."
 140
 141     if defined?(Bundler)
 142       msg += " Add #{gem} to your Gemfile or gemspec."
 143
 144       # We detect the gem name from caller_locations. We need to skip 2 frames like:
 145       # lib/ruby/3.3.0+0/bundled_gems.rb:90:in `warning?'",
 146       # lib/ruby/3.3.0+0/bundler/rubygems_integration.rb:247:in `block (2 levels) in replace_require'",
 147       #
 148       # Additionally, we need to skip Bootsnap and Zeitwerk if present, these
 149       # gems decorate Kernel#require, so they are not really the ones issuing
 150       # the require call users should be warned about. Those are upwards.
 151       location = Thread.each_caller_location(2) do |cl|
 152         break cl.path unless cl.base_label == "require"
 153       end
 154
 155       if location && File.file?(location) && !location.start_with?(Gem::BUNDLED_GEMS::LIBDIR)
 156         caller_gem = nil
 157         Gem.path.each do |path|
 158           if location =~ %r{#{path}/gems/([\w\-\.]+)}
 159             caller_gem = $1
 160             break
 161           end
 162         end
 163         if caller_gem
 164           msg += " Also contact author of #{caller_gem} to add #{gem} into its gemspec."
 165         end
 166       end
 167     else
 168       msg += " Install #{gem} from RubyGems."
 169     end
 170
 171     msg
 172   end
 173
 174   freeze
 175 end
 176
 177 # for RubyGems without Bundler environment.
 178 # If loading library is not part of the default gems and the bundled gems, warn it.
 179 class LoadError
 180   def message
 181     return super unless path
 182
 183     name = path.tr("/", "-")
 184     if !defined?(Bundler) && Gem::BUNDLED_GEMS::SINCE[name] && !Gem::BUNDLED_GEMS::WARNED[name]
 185       warn name + Gem::BUNDLED_GEMS.build_message(name)
 186     end
 187     super
 188   end
 189 end
 190
 191 # :startdoc: