Module: Gem::BUNDLED_GEMS

Defined in:
lib/bundled_gems.rb

Overview

:stopdoc:

Constant Summary collapse

SINCE = 
{
  "rexml" => "3.0.0",
  "rss" => "3.0.0",
  "webrick" => "3.0.0",
  "matrix" => "3.1.0",
  "net-ftp" => "3.1.0",
  "net-imap" => "3.1.0",
  "net-pop" => "3.1.0",
  "net-smtp" => "3.1.0",
  "prime" => "3.1.0",
  "racc" => "3.3.0",
  "abbrev" => "3.4.0",
  "base64" => "3.4.0",
  "bigdecimal" => "3.4.0",
  "csv" => "3.4.0",
  "drb" => "3.4.0",
  "getoptlong" => "3.4.0",
  "mutex_m" => "3.4.0",
  "nkf" => "3.4.0",
  "observer" => "3.4.0",
  "resolv-replace" => "3.4.0",
  "rinda" => "3.4.0",
  "syslog" => "3.4.0",
}.freeze
EXACT = 
{
  "abbrev" => true,
  "base64" => true,
  "bigdecimal" => true,
  "csv" => true,
  "drb" => true,
  "getoptlong" => true,
  "mutex_m" => true,
  "nkf" => true, "kconv" => "nkf",
  "observer" => true,
  "resolv-replace" => true,
  "rinda" => true,
  "syslog" => true,
}.freeze
PREFIXED = 
{
  "bigdecimal" => true,
  "csv" => true,
  "drb" => true,
  "rinda" => true,
  "syslog" => true,
}.freeze
WARNED =

unfrozen

{}
LIBDIR = 
(conf["rubylibdir"] + "/").freeze
ARCHDIR = 
(conf["rubyarchdir"] + "/").freeze
DLEXT = 
/\.#{Regexp.union(dlext)}\z/
LIBEXT = 
/\.#{Regexp.union("rb", *dlext)}\z/

Class Method Summary collapse

Class Method Details

.build_message(gem) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/bundled_gems.rb', line 132

def self.build_message(gem)
  msg = " #{RUBY_VERSION < SINCE[gem] ? "will no longer be" : "is not"} part of the default gems since Ruby #{SINCE[gem]}."

  if defined?(Bundler)
    msg += " Add #{gem} to your Gemfile or gemspec."
    # We detect the gem name from caller_locations. We need to skip 2 frames like:
    # lib/ruby/3.3.0+0/bundled_gems.rb:90:in `warning?'",
    # lib/ruby/3.3.0+0/bundler/rubygems_integration.rb:247:in `block (2 levels) in replace_require'",
    location = caller_locations(3,1)[0]&.path
    if File.file?(location) && !location.start_with?(Gem::BUNDLED_GEMS::LIBDIR)
      caller_gem = nil
      Gem.path.each do |path|
        if location =~ %r{#{path}/gems/([\w\-\.]+)}
          caller_gem = $1
          break
        end
      end
      if caller_gem
        msg += " Also contact author of #{caller_gem} to add #{gem} into its gemspec."
      end
    end
  else
    msg += " Install #{gem} from RubyGems."
  end

  msg
end

.find_gem(path) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/bundled_gems.rb', line 84

def self.find_gem(path)
  if !path
    return
  elsif path.start_with?(ARCHDIR)
    n = path.delete_prefix(ARCHDIR).sub(DLEXT, "")
  elsif path.start_with?(LIBDIR)
    n = path.delete_prefix(LIBDIR).chomp(".rb")
  else
    return
  end
  EXACT[n] or PREFIXED[n = n[%r[\A[^/]+(?=/)]]] && n
end

.replace_require(specs) ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/bundled_gems.rb', line 63

def self.replace_require(specs)
  return if [::Kernel.singleton_class, ::Kernel].any? {|klass| klass.respond_to?(:no_warning_require) }

  spec_names = specs.to_a.each_with_object({}) {|spec, h| h[spec.name] = true }

  [::Kernel.singleton_class, ::Kernel].each do |kernel_class|
    kernel_class.send(:alias_method, :no_warning_require, :require)
    kernel_class.send(:define_method, :require) do |name|
      if message = ::Gem::BUNDLED_GEMS.warning?(name, specs: spec_names) # rubocop:disable Style/HashSyntax
        warn message, :uplevel => 1
      end
      kernel_class.send(:no_warning_require, name)
    end
    if kernel_class == ::Kernel
      kernel_class.send(:private, :require)
    else
      kernel_class.send(:public, :require)
    end
  end
end

.warning?(name, specs: nil) ⇒ Boolean

Returns:

  • (Boolean) 


97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/bundled_gems.rb', line 97

def self.warning?(name, specs: nil)
  feature = File.path(name) # name can be a feature name or a file path with String or Pathname
  name = feature.tr("/", "-")
  name.sub!(LIBEXT, "")
  return if specs.include?(name)
  _t, path = $:.resolve_feature_path(feature)
  if gem = find_gem(path)
    return if specs.include?(gem)
    caller = caller_locations(3, 3).find {|c| c&.absolute_path}
    return if find_gem(caller&.absolute_path)
  elsif SINCE[name]
    gem = true
  else
    return
  end
  # Warning feature is not working correctly with Bootsnap.
  # caller_locations returns:
  #   lib/ruby/3.3.0+0/bundled_gems.rb:65:in `block (2 levels) in replace_require'
  #   $GEM_HOME/gems/bootsnap-1.17.0/lib/bootsnap/load_path_cache/core_ext/kernel_require.rb:32:in `require'"
  #   ...
  return if caller_locations(2).find {|c| c&.path.match?(/bootsnap/) }
  return if WARNED[name]
  WARNED[name] = true
  if gem == true
    gem = name
    "#{feature} was loaded from the standard library, but"
  elsif gem
    return if WARNED[gem]
    WARNED[gem] = true
    "#{feature} is found in #{gem}, which"
  else
    return
  end + build_message(gem)
end