rubygems-update 3.7.2 → 4.0.0.beta1

data/lib/rubygems/ext/cmake_builder.rb

@@ -1,21 +1,110 @@
 # frozen_string_literal: true
 
+# This builder creates extensions defined using CMake. Its is invoked if a Gem's spec file
+# sets the `extension` property to a string that contains `CMakeLists.txt`.
+#
+# In general, CMake projects are built in two steps:
+#
+#  * configure
+#  * build
+#
+# The builder follow this convention. First it runs a configuration step and then it runs a build step.
+#
+# CMake projects can be quite configurable - it is likely you will want to specify options when
+# installing a gem. To pass options to CMake specify them after `--` in the gem install command. For example:
+#
+#   gem install <gem_name> -- --preset <preset_name>
+#
+# Note that options are ONLY sent to the configure step - it is not currently possible to specify
+# options for the build step. If this becomes and issue then the CMake builder can be updated to
+# support build options.
+#
+# Useful options to know are:
+#
+#  -G to specify a generator (-G Ninja is recommended)
+#  -D<CMAKE_VARIABLE> to set a CMake variable (for example -DCMAKE_BUILD_TYPE=Release)
+#  --preset <preset_name> to use a preset
+#
+# If the Gem author provides presets, via CMakePresets.json file, you will likely want to use one of them.
+# If not, you may wish to specify a generator. Ninja is recommended because it can build projects in parallel
+# and thus much faster than building them serially like Make does.
+
 class Gem::Ext::CmakeBuilder < Gem::Ext::Builder
-  def self.build(extension, dest_path, results, args=[], lib_dir=nil, cmake_dir=Dir.pwd,
-    target_rbconfig=Gem.target_rbconfig)
+  attr_accessor :runner, :profile
+  def initialize
+    @runner = self.class.method(:run)
+    @profile = :release
+  end
+
+  def build(extension, dest_path, results, args = [], lib_dir = nil, cmake_dir = Dir.pwd,
+    target_rbconfig = Gem.target_rbconfig)
     if target_rbconfig.path
       warn "--target-rbconfig is not yet supported for CMake extensions. Ignoring"
     end
 
-    unless File.exist?(File.join(cmake_dir, "Makefile"))
-      require_relative "../command"
-      cmd = ["cmake", ".", "-DCMAKE_INSTALL_PREFIX=#{dest_path}", *Gem::Command.build_args]
+    # Figure the build dir
+    build_dir = File.join(cmake_dir, "build")
 
-      run cmd, results, class_name, cmake_dir
-    end
+    # Check if the gem defined presets
+    check_presets(cmake_dir, args, results)
+
+    # Configure
+    configure(cmake_dir, build_dir, dest_path, args, results)
 
-    make dest_path, results, cmake_dir, target_rbconfig: target_rbconfig
+    # Compile
+    compile(cmake_dir, build_dir, args, results)
 
     results
   end
+
+  def configure(cmake_dir, build_dir, install_dir, args, results)
+    cmd = ["cmake",
+           cmake_dir,
+           "-B",
+           build_dir,
+           "-DCMAKE_RUNTIME_OUTPUT_DIRECTORY=#{install_dir}", # Windows
+           "-DCMAKE_LIBRARY_OUTPUT_DIRECTORY=#{install_dir}", # Not Windows
+           *Gem::Command.build_args,
+           *args]
+
+    runner.call(cmd, results, "cmake_configure", cmake_dir)
+  end
+
+  def compile(cmake_dir, build_dir, args, results)
+    cmd = ["cmake",
+           "--build",
+           build_dir.to_s,
+           "--config",
+           @profile.to_s]
+
+    runner.call(cmd, results, "cmake_compile", cmake_dir)
+  end
+
+  private
+
+  def check_presets(cmake_dir, args, results)
+    # Return if the user specified a preset
+    return unless args.grep(/--preset/i).empty?
+
+    cmd = ["cmake",
+           "--list-presets"]
+
+    presets = Array.new
+    begin
+      runner.call(cmd, presets, "cmake_presets", cmake_dir)
+
+      # Remove the first two lines of the array which is the current_directory and the command
+      # that was run
+      presets = presets[2..].join
+      results << <<~EOS
+        The gem author provided a list of presets that can be used to build the gem. To use a preset specify it on the command line:
+
+          gem install <gem_name> -- --preset <preset_name>
+
+        #{presets}
+      EOS
+    rescue Gem::InstallError
+      # Do nothing, CMakePresets.json was not included in the Gem
+    end
+  end
 end

data/lib/rubygems/ext/configure_builder.rb

@@ -7,8 +7,8 @@
 #++
 
 class Gem::Ext::ConfigureBuilder < Gem::Ext::Builder
-  def self.build(extension, dest_path, results, args=[], lib_dir=nil, configure_dir=Dir.pwd,
-    target_rbconfig=Gem.target_rbconfig)
+  def self.build(extension, dest_path, results, args = [], lib_dir = nil, configure_dir = Dir.pwd,
+    target_rbconfig = Gem.target_rbconfig)
     if target_rbconfig.path
       warn "--target-rbconfig is not yet supported for configure-based extensions. Ignoring"
     end

data/lib/rubygems/ext/ext_conf_builder.rb

@@ -7,8 +7,8 @@
 #++
 
 class Gem::Ext::ExtConfBuilder < Gem::Ext::Builder
-  def self.build(extension, dest_path, results, args=[], lib_dir=nil, extension_dir=Dir.pwd,
-    target_rbconfig=Gem.target_rbconfig)
+  def self.build(extension, dest_path, results, args = [], lib_dir = nil, extension_dir = Dir.pwd,
+    target_rbconfig = Gem.target_rbconfig)
     require "fileutils"
     require "tempfile"
 
@@ -66,6 +66,10 @@ class Gem::Ext::ExtConfBuilder < Gem::Ext::Builder
     end
 
     results
+  rescue Gem::Ext::Builder::NoMakefileError => error
+    results << error.message
+    results << "Skipping make for #{extension} as no Makefile was found."
+    # We are good, do not re-raise the error.
   ensure
     FileUtils.rm_rf tmp_dest if tmp_dest
   end

data/lib/rubygems/ext/rake_builder.rb

@@ -7,8 +7,8 @@
 #++
 
 class Gem::Ext::RakeBuilder < Gem::Ext::Builder
-  def self.build(extension, dest_path, results, args=[], lib_dir=nil, extension_dir=Dir.pwd,
-    target_rbconfig=Gem.target_rbconfig)
+  def self.build(extension, dest_path, results, args = [], lib_dir = nil, extension_dir = Dir.pwd,
+    target_rbconfig = Gem.target_rbconfig)
     if target_rbconfig.path
       warn "--target-rbconfig is not yet supported for Rake extensions. Ignoring"
     end

data/lib/rubygems/gem_runner.rb

@@ -8,7 +8,6 @@
 
 require_relative "../rubygems"
 require_relative "command_manager"
-require_relative "deprecate"
 
 ##
 # Run an instance of the gem program.

data/lib/rubygems/install_update_options.rb

@@ -158,10 +158,9 @@ module Gem::InstallUpdateOptions
       options[:without_groups].concat v.map(&:intern)
     end
 
-    add_option(:"Install/Update", "--default",
+    add_option(:Deprecated, "--default",
                "Add the gem's full specification to",
                "specifications/default and extract only its bin") do |v,_o|
-      options[:install_as_default] = v
     end
 
     add_option(:"Install/Update", "--explain",

data/lib/rubygems/installer.rb

@@ -8,7 +8,6 @@
 
 require_relative "installer_uninstaller_utils"
 require_relative "exceptions"
-require_relative "deprecate"
 require_relative "package"
 require_relative "ext"
 require_relative "user_interaction"
@@ -27,8 +26,6 @@ require_relative "user_interaction"
 # file.  See Gem.pre_install and Gem.post_install for details.
 
 class Gem::Installer
-  extend Gem::Deprecate
-
   ##
   # Paths where env(1) might live.  Some systems are broken and have it in
   # /bin
@@ -67,23 +64,6 @@ class Gem::Installer
   attr_reader :package
 
   class << self
-    #
-    # Changes in rubygems to lazily loading `rubygems/command` (in order to
-    # lazily load `optparse` as a side effect) affect bundler's custom installer
-    # which uses `Gem::Command` without requiring it (up until bundler 2.2.29).
-    # This hook is to compensate for that missing require.
-    #
-    # TODO: Remove when rubygems no longer supports running on bundler older
-    # than 2.2.29.
-
-    def inherited(klass)
-      if klass.name == "Bundler::RubyGemsGemInstaller"
-        require "rubygems/command"
-      end
-
-      super(klass)
-    end
-
     ##
     # Overrides the executable format.
     #
@@ -170,7 +150,7 @@ class Gem::Installer
   #               process. If not set, then Gem::Command.build_args is used
   # :post_install_message:: Print gem post install message if true
 
-  def initialize(package, options={})
+  def initialize(package, options = {})
     require "fileutils"
 
     @options = options
@@ -291,11 +271,7 @@ class Gem::Installer
     run_pre_install_hooks
 
     # Set loaded_from to ensure extension_dir is correct
-    if @options[:install_as_default]
-      spec.loaded_from = default_spec_file
-    else
-      spec.loaded_from = spec_file
-    end
+    spec.loaded_from = spec_file
 
     # Completely remove any previous gem files
     FileUtils.rm_rf gem_dir
@@ -304,24 +280,17 @@ class Gem::Installer
     dir_mode = options[:dir_mode]
     FileUtils.mkdir_p gem_dir, mode: dir_mode && 0o755
 
-    if @options[:install_as_default]
-      extract_bin
-      write_default_spec
-    else
-      extract_files
+    extract_files
 
-      build_extensions
-      write_build_info_file
-      run_post_build_hooks
-    end
+    build_extensions
+    write_build_info_file
+    run_post_build_hooks
 
     generate_bin
     generate_plugins
 
-    unless @options[:install_as_default]
-      write_spec
-      write_cache_file
-    end
+    write_spec
+    write_cache_file
 
     File.chmod(dir_mode, gem_dir) if dir_mode
 
@@ -409,15 +378,6 @@ class Gem::Installer
     !dependency.matching_specs.empty?
   end
 
-  ##
-  # Unpacks the gem into the given directory.
-
-  def unpack(directory)
-    @gem_dir = directory
-    extract_files
-  end
-  rubygems_deprecate :unpack
-
   ##
   # The location of the spec file that is installed.
   #
@@ -426,12 +386,18 @@ class Gem::Installer
     File.join gem_home, "specifications", "#{spec.full_name}.gemspec"
   end
 
+  def default_spec_dir
+    dir = File.join(gem_home, "specifications", "default")
+    FileUtils.mkdir_p dir
+    dir
+  end
+
   ##
   # The location of the default spec file for default gems.
   #
 
   def default_spec_file
-    File.join gem_home, "specifications", "default", "#{spec.full_name}.gemspec"
+    File.join default_spec_dir, "#{spec.full_name}.gemspec"
   end
 
   ##
@@ -906,11 +872,7 @@ class Gem::Installer
 
     ensure_loadable_spec
 
-    if options[:install_as_default]
-      Gem.ensure_default_gem_subdirectories gem_home
-    else
-      Gem.ensure_gem_subdirectories gem_home
-    end
+    Gem.ensure_gem_subdirectories gem_home
 
     return true if @force
 

data/lib/rubygems/name_tuple.rb

@@ -6,7 +6,7 @@
 # wrap the data returned from the indexes.
 
 class Gem::NameTuple
-  def initialize(name, version, platform=Gem::Platform::RUBY)
+  def initialize(name, version, platform = Gem::Platform::RUBY)
     @name = name
     @version = version
 
@@ -81,6 +81,12 @@ class Gem::NameTuple
     [@name, @version, @platform]
   end
 
+  alias_method :deconstruct, :to_a
+
+  def deconstruct_keys(keys)
+    { name: @name, version: @version, platform: @platform }
+  end
+
   def inspect # :nodoc:
     "#<Gem::NameTuple #{@name}, #{@version}, #{@platform}>"
   end

data/lib/rubygems/package/tar_header.rb

@@ -56,7 +56,7 @@ class Gem::Package::TarHeader
   ##
   # Pack format for a tar header
 
-  PACK_FORMAT = "a100" + # name
+  PACK_FORMAT = ("a100" + # name
                 "a8"   + # mode
                 "a8"   + # uid
                 "a8"   + # gid
@@ -71,12 +71,12 @@ class Gem::Package::TarHeader
                 "a32"  + # gname
                 "a8"   + # devmajor
                 "a8"   + # devminor
-                "a155"   # prefix
+                "a155").freeze # prefix
 
   ##
   # Unpack format for a tar header
 
-  UNPACK_FORMAT = "A100" + # name
+  UNPACK_FORMAT = ("A100" + # name
                   "A8"   + # mode
                   "A8"   + # uid
                   "A8"   + # gid
@@ -91,7 +91,7 @@ class Gem::Package::TarHeader
                   "A32"  + # gname
                   "A8"   + # devmajor
                   "A8"   + # devminor
-                  "A155"   # prefix
+                  "A155").freeze # prefix
 
   attr_reader(*FIELDS)
 

data/lib/rubygems/package/tar_reader.rb

@@ -30,6 +30,8 @@ class Gem::Package::TarReader
     nil
   end
 
+  attr_reader :io # :nodoc:
+
   ##
   # Creates a new tar file reader on +io+ which needs to respond to #pos,
   # #eof?, #read, #getc and #pos=

data/lib/rubygems/package/tar_writer.rb

@@ -99,7 +99,7 @@ class Gem::Package::TarWriter
   # Gem.source_date_epoch if not specified), and yields an IO for
   # writing the file to
 
-  def add_file(name, mode, mtime=nil) # :yields: io
+  def add_file(name, mode, mtime = nil) # :yields: io
     check_closed
 
     name, prefix = split_name name

data/lib/rubygems/package.rb

@@ -7,6 +7,7 @@
 
 # rubocop:enable Style/AsciiComments
 
+require_relative "win_platform"
 require_relative "security"
 require_relative "user_interaction"
 
@@ -267,7 +268,7 @@ class Gem::Package
 
       tar.add_file_simple file, stat.mode, stat.size do |dst_io|
         File.open file, "rb" do |src_io|
-          copy_stream(src_io, dst_io)
+          copy_stream(src_io, dst_io, stat.size)
         end
       end
     end
@@ -436,8 +437,6 @@ EOM
           symlinks << [full_name, link_target, destination, real_destination]
         end
 
-        FileUtils.rm_rf destination
-
         mkdir =
           if entry.directory?
             destination
@@ -451,8 +450,14 @@ EOM
         end
 
         if entry.file?
-          File.open(destination, "wb") {|out| copy_stream(entry, out) }
-          FileUtils.chmod file_mode(entry.header.mode) & ~File.umask, destination
+          File.open(destination, "wb") do |out|
+            copy_stream(tar.io, out, entry.size)
+            # Flush needs to happen before chmod because there could be data
+            # in the IO buffer that needs to be written, and that could be
+            # written after the chmod (on close) which would mess up the perms
+            out.flush
+            out.chmod file_mode(entry.header.mode) & ~File.umask
+          end
         end
 
         verbose destination
@@ -514,10 +519,12 @@ EOM
     destination
   end
 
-  def normalize_path(pathname)
-    if Gem.win_platform?
+  if Gem.win_platform?
+    def normalize_path(pathname) # :nodoc:
       pathname.downcase
-    else
+    end
+  else
+    def normalize_path(pathname) # :nodoc:
       pathname
     end
   end
@@ -635,6 +642,8 @@ EOM
     raise Gem::Package::FormatError.new e.message, @gem
   end
 
+  private
+
   ##
   # Verifies the +checksums+ against the +digests+.  This check is not
   # cryptographically secure.  Missing checksums are ignored.
@@ -715,12 +724,12 @@ EOM
   end
 
   if RUBY_ENGINE == "truffleruby"
-    def copy_stream(src, dst) # :nodoc:
-      dst.write src.read
+    def copy_stream(src, dst, size) # :nodoc:
+      dst.write src.read(size)
     end
   else
-    def copy_stream(src, dst) # :nodoc:
-      IO.copy_stream(src, dst)
+    def copy_stream(src, dst, size) # :nodoc:
+      IO.copy_stream(src, dst, size)
     end
   end
 

data/lib/rubygems/platform.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "deprecate"
-
 ##
 # Available list of platforms for targeting Gem installations.
 #
@@ -21,15 +19,6 @@ class Gem::Platform
     end
   end
 
-  def self.match(platform)
-    match_platforms?(platform, Gem.platforms)
-  end
-
-  class << self
-    extend Gem::Deprecate
-    rubygems_deprecate :match, "Gem::Platform.match_spec? or match_gem?"
-  end
-
   def self.match_platforms?(platform, platforms)
     platform = Gem::Platform.new(platform) unless platform.is_a?(Gem::Platform)
     platforms.any? do |local_platform|
@@ -146,6 +135,37 @@ class Gem::Platform
     to_a.compact.join(@cpu.nil? ? "" : "-")
   end
 
+  ##
+  # Deconstructs the platform into an array for pattern matching.
+  # Returns [cpu, os, version].
+  #
+  #   Gem::Platform.new("x86_64-linux").deconstruct  #=> ["x86_64", "linux", nil]
+  #
+  # This enables array pattern matching:
+  #
+  #   case Gem::Platform.new("arm64-darwin-21")
+  #   in ["arm64", "darwin", version]
+  #     # version => "21"
+  #   end
+  alias_method :deconstruct, :to_a
+
+  ##
+  # Deconstructs the platform into a hash for pattern matching.
+  # Returns a hash with keys +:cpu+, +:os+, and +:version+.
+  #
+  #   Gem::Platform.new("x86_64-darwin-20").deconstruct_keys(nil)
+  #   #=> { cpu: "x86_64", os: "darwin", version: "20" }
+  #
+  # This enables hash pattern matching:
+  #
+  #   case Gem::Platform.new("x86_64-linux")
+  #   in cpu: "x86_64", os: "linux"
+  #     # Matches Linux on x86_64
+  #   end
+  def deconstruct_keys(keys)
+    { cpu: @cpu, os: @os, version: @version }
+  end
+
   ##
   # Is +other+ equal to this platform?  Two platforms are equal if they have
   # the same CPU, OS and version.

data/lib/rubygems/remote_fetcher.rb

@@ -72,7 +72,7 @@ class Gem::RemoteFetcher
   # +headers+: A set of additional HTTP headers to be sent to the server when
   #            fetching the gem.
 
-  def initialize(proxy=nil, dns=nil, headers={})
+  def initialize(proxy = nil, dns = nil, headers = {})
     require_relative "core_ext/tcpsocket_init" if Gem.configuration.ipv4_fallback_enabled
     require_relative "vendored_net_http"
     require_relative "vendor/uri/lib/uri"
@@ -245,11 +245,14 @@ class Gem::RemoteFetcher
   def fetch_path(uri, mtime = nil, head = false)
     uri = Gem::Uri.new uri
 
-    unless uri.scheme
-      raise ArgumentError, "uri scheme is invalid: #{uri.scheme.inspect}"
-    end
+    method = {
+      "http" => "fetch_http",
+      "https" => "fetch_http",
+      "s3" => "fetch_s3",
+      "file" => "fetch_file",
+    }.fetch(uri.scheme) { raise ArgumentError, "uri scheme is invalid: #{uri.scheme.inspect}" }
 
-    data = send "fetch_#{uri.scheme}", uri, mtime, head
+    data = send method, uri, mtime, head
 
     if data && !head && uri.to_s.end_with?(".gz")
       begin

data/lib/rubygems/resolver/conflict.rb

@@ -21,7 +21,7 @@ class Gem::Resolver::Conflict
   # Creates a new resolver conflict when +dependency+ is in conflict with an
   # already +activated+ specification.
 
-  def initialize(dependency, activated, failed_dep=dependency)
+  def initialize(dependency, activated, failed_dep = dependency)
     @dependency = dependency
     @activated = activated
     @failed_dep = failed_dep

data/lib/rubygems/resolver.rb

@@ -144,7 +144,7 @@ class Gem::Resolver
     [spec, activation_request]
   end
 
-  def requests(s, act, reqs=[]) # :nodoc:
+  def requests(s, act, reqs = []) # :nodoc:
     return reqs if @ignore_dependencies
 
     s.fetch_development_dependencies if @development

data/lib/rubygems/security/signer.rb

@@ -52,7 +52,7 @@ class Gem::Security::Signer
     re_signed_cert = Gem::Security.re_sign(
       expired_cert,
       private_key,
-      (Gem::Security::ONE_DAY * Gem.configuration.cert_expiration_length_days)
+      Gem::Security::ONE_DAY * Gem.configuration.cert_expiration_length_days
     )
 
     Gem::Security.write(re_signed_cert, expired_cert_path)

data/lib/rubygems/source.rb

@@ -190,7 +190,7 @@ class Gem::Source
   # Downloads +spec+ and writes it to +dir+.  See also
   # Gem::RemoteFetcher#download.
 
-  def download(spec, dir=Dir.pwd)
+  def download(spec, dir = Dir.pwd)
     fetcher = Gem::RemoteFetcher.fetcher
     fetcher.download spec, uri.to_s, dir
   end
@@ -210,7 +210,7 @@ class Gem::Source
     end
   end
 
-  def typo_squatting?(host, distance_threshold=4)
+  def typo_squatting?(host, distance_threshold = 4)
     return if @uri.host.nil?
     levenshtein_distance(@uri.host, host).between? 1, distance_threshold
   end

data/lib/rubygems/spec_fetcher.rb

@@ -83,7 +83,7 @@ class Gem::SpecFetcher
   #
   # If +matching_platform+ is false, gems for all platforms are returned.
 
-  def search_for_dependency(dependency, matching_platform=true)
+  def search_for_dependency(dependency, matching_platform = true)
     found = {}
 
     rejected_specs = {}
@@ -130,7 +130,7 @@ class Gem::SpecFetcher
   ##
   # Return all gem name tuples who's names match +obj+
 
-  def detect(type=:complete)
+  def detect(type = :complete)
     tuples = []
 
     list, _ = available_specs(type)
@@ -150,7 +150,7 @@ class Gem::SpecFetcher
   #
   # If +matching_platform+ is false, gems for all platforms are returned.
 
-  def spec_for_dependency(dependency, matching_platform=true)
+  def spec_for_dependency(dependency, matching_platform = true)
     tuples, errors = search_for_dependency(dependency, matching_platform)
 
     specs = []
@@ -280,7 +280,7 @@ class Gem::SpecFetcher
   # Retrieves NameTuples from +source+ of the given +type+ (:prerelease,
   # etc.).  If +gracefully_ignore+ is true, errors are ignored.
 
-  def tuples_for(source, type, gracefully_ignore=false) # :nodoc:
+  def tuples_for(source, type, gracefully_ignore = false) # :nodoc:
     @caches[type][source.uri] ||=
       source.load_specs(type).sort_by(&:name)
   rescue Gem::RemoteFetcher::FetchError