rubygems-generate_index 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e89ec0ba401376957ef5cd59bfaecd5e77bc043775fa0f4414332dffab489aa
+  data.tar.gz: 9032f6fe7bb94da4d1b9c11bfd29bbbd0f6bb4bc74d054c2825c833121ea84c0
+SHA512:
+  metadata.gz: ad0f57dd0f7a01f1b6702848190c5623af4787ffde8817ee090fb334b1c575f47f112f21aee01d047dbe12df1409635a40abb55ae9617bd3c29dd913de91c458
+  data.tar.gz: ee119a9d5bad9b7045d22868eaf08e4c2efbc9097eb03ed1f9cd2f3b858da00fbedc596fc839d22aa2db7f6a51ea41cef7ae3ce3fd4fc7f8d94ce1130bf24b75

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,81 @@
+# RubyGems and Bundler Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at team@bundler.io, or directly contacting project team members via email or Slack. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubygems-generate_index.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "test-unit", "~> 3.0"
+install_if -> { RUBY_VERSION >= "2.7" } do
+  gem "rubocop", "~> 1.21"
+  gem "rubocop-performance", "~> 1.19"
+end
+install_if -> { Gem::VERSION < "3.2.0" } do
+  gem "builder", "~> 3.2"
+end

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    rubygems-generate_index (1.0.0)
+      compact_index (~> 0.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    builder (3.2.4)
+    compact_index (0.14.0)
+    json (2.6.3)
+    json (2.6.3-java)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.3)
+    racc (1.7.1)
+    racc (1.7.1-java)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rubocop (1.56.3)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.19.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    test-unit (3.6.1)
+      power_assert
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin
+  arm64-linux
+  java
+  ruby
+  x64-linux
+
+DEPENDENCIES
+  builder (~> 3.2)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-performance (~> 1.19)
+  rubygems-generate_index!
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.4.19

data/LICENSE.txt

@@ -0,0 +1,54 @@
+RubyGems is copyrighted free software by Chad Fowler, Rich Kilmer, Jim
+Weirich and others.  You can redistribute it and/or modify it under
+either the terms of the MIT license (see the file MIT.txt), or the
+conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard executables non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+   a. distribute the executables and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard executables non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.
+

data/MIT.txt

@@ -0,0 +1,21 @@
+Copyright (c) Chad Fowler, Rich Kilmer, Jim Weirich and others.
+Portions copyright (c) Engine Yard and Andre Arko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,11 @@
+CODE_OF_CONDUCT.md
+Gemfile
+Gemfile.lock
+LICENSE.txt
+MIT.txt
+Manifest.txt
+README.md
+lib/rubygems/commands/generate_index_command.rb
+lib/rubygems/indexer.rb
+lib/rubygems_plugin.rb
+rubygems-generate_index.gemspec

data/README.md

@@ -0,0 +1,59 @@
+# rubygems-generate_index
+
+rubygems-generate_index generates the index files for a `gem server` directory.
+
+The generate_index command creates a set of indexes for serving gems
+statically. The command expects a 'gems' directory under the path given to
+the --directory option. The given directory will be the directory you serve
+as the gem repository.
+
+For `gem generate_index --directory /path/to/repo`, expose /path/to/repo via
+your HTTP server configuration (not /path/to/repo/gems).
+
+When done, it will generate a set of files like this:
+
+```
+  gems/*.gem                                   # .gem files you want to
+                                               # index
+
+  specs.<version>.gz                           # specs index
+  latest_specs.<version>.gz                    # latest specs index
+  prerelease_specs.<version>.gz                # prerelease specs index
+  quick/Marshal.<version>/<gemname>.gemspec.rz # Marshal quick index file
+```
+
+The .rz extension files are compressed with the inflate algorithm.
+The Marshal version number comes from ruby's Marshal::MAJOR_VERSION and
+Marshal::MINOR_VERSION constants. It is used to ensure compatibility.
+
+This gem is a replacement for the `gem generate_index` command that was removed in RubyGems 3.5.0.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubygems-generate_index'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubygems-generate_index
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rubygems/rubygems-generate_index.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rubygems/commands/generate_index_command.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "rubygems/command"
+require_relative "../indexer"
+
+##
+# Generates a index files for use as a gem server.
+#
+# See `gem help generate_index`
+
+class Gem::Commands::GenerateIndexCommand < Gem::Command
+  def initialize
+    super "generate_index",
+          "Generates the index files for a gem server directory",
+          :directory => ".", :build_modern => true
+
+    @deprecated_options = { "generate_index" => {} } unless defined?(@deprecated_options)
+
+    add_option "-d", "--directory=DIRNAME",
+               "repository base dir containing gems subdir" do |dir, options|
+      options[:directory] = File.expand_path dir
+    end
+
+    add_option "--[no-]modern",
+               "Generate indexes for RubyGems",
+               "(always true)" do |value, options|
+      options[:build_modern] = value
+    end
+
+    deprecate_option("--modern", version: "4.0", extra_msg: "Modern indexes (specs, latest_specs, and prerelease_specs) are always generated, so this option is not needed.")
+    deprecate_option("--no-modern", version: "4.0", extra_msg: "The `--no-modern` option is currently ignored. Modern indexes (specs, latest_specs, and prerelease_specs) are always generated.")
+
+    add_option "--update",
+               "Update modern indexes with gems added",
+               "since the last update" do |value, options|
+      options[:update] = value
+    end
+  end
+
+  def defaults_str # :nodoc:
+    "--directory . --modern"
+  end
+
+  def description # :nodoc:
+    <<-EOF
+The generate_index command creates a set of indexes for serving gems
+statically.  The command expects a 'gems' directory under the path given to
+the --directory option.  The given directory will be the directory you serve
+as the gem repository.
+
+For `gem generate_index --directory /path/to/repo`, expose /path/to/repo via
+your HTTP server configuration (not /path/to/repo/gems).
+
+When done, it will generate a set of files like this:
+
+  gems/*.gem                                   # .gem files you want to
+                                               # index
+
+  specs.<version>.gz                           # specs index
+  latest_specs.<version>.gz                    # latest specs index
+  prerelease_specs.<version>.gz                # prerelease specs index
+  quick/Marshal.<version>/<gemname>.gemspec.rz # Marshal quick index file
+
+The .rz extension files are compressed with the inflate algorithm.
+The Marshal version number comes from ruby's Marshal::MAJOR_VERSION and
+Marshal::MINOR_VERSION constants.  It is used to ensure compatibility.
+    EOF
+  end
+
+  def execute
+    # This is always true because it's the only way now.
+    options[:build_modern] = true
+
+    if !File.exist?(options[:directory]) ||
+       !File.directory?(options[:directory])
+      alert_error "unknown directory name #{options[:directory]}."
+      terminate_interaction 1
+    else
+      indexer = Gem::Indexer.new options.delete(:directory), options
+
+      if options[:update]
+        indexer.update_index
+      else
+        indexer.generate_index
+      end
+    end
+  end
+
+  unless allocate.respond_to?(:deprecate_option)
+    def deprecate_option(name, version: nil, extra_msg: nil)
+      @deprecated_options[command].merge!({ name => { "rg_version_to_expire" => version, "extra_msg" => extra_msg } })
+    end
+
+    def check_deprecated_options(options)
+      options.each do |option|
+        next unless option_is_deprecated?(option)
+        deprecation = @deprecated_options[command][option]
+        version_to_expire = deprecation["rg_version_to_expire"]
+
+        deprecate_option_msg = if version_to_expire
+          "The \"#{option}\" option has been deprecated and will be removed in Rubygems #{version_to_expire}."
+        else
+          "The \"#{option}\" option has been deprecated and will be removed in future versions of Rubygems."
+        end
+
+        extra_msg = deprecation["extra_msg"]
+
+        deprecate_option_msg += " #{extra_msg}" if extra_msg
+
+        alert_warning(deprecate_option_msg)
+      end
+    end
+
+    def handle_options(args)
+      super
+      check_deprecated_options(args)
+    end
+
+    private
+
+    def option_is_deprecated?(option)
+      @deprecated_options[command].key?(option)
+    end
+  end
+end

data/lib/rubygems/indexer.rb

@@ -0,0 +1,452 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "rubygems/package"
+require "tmpdir"
+
+if Gem::VERSION < "3.2.0"
+  begin
+    gem "builder"
+    require "builder/xchar"
+  rescue *rescue_exceptions
+  end
+end
+
+##
+# Top level class for building the gem repository index.
+
+class Gem::Indexer
+  include Gem::UserInteraction
+
+  ##
+  # Build indexes for RubyGems 1.2.0 and newer when true
+
+  attr_accessor :build_modern
+
+  ##
+  # Index install location
+
+  attr_reader :dest_directory
+
+  ##
+  # Specs index install location
+
+  attr_reader :dest_specs_index
+
+  ##
+  # Latest specs index install location
+
+  attr_reader :dest_latest_specs_index
+
+  ##
+  # Prerelease specs index install location
+
+  attr_reader :dest_prerelease_specs_index
+
+  ##
+  # Index build directory
+
+  attr_reader :directory
+
+  ##
+  # Create an indexer that will index the gems in +directory+.
+
+  def initialize(directory, options = {})
+    require "fileutils"
+    require "tmpdir"
+    require "zlib"
+
+    if Gem::VERSION < "3.2.0" && !defined?(Builder::XChar)
+      raise "Gem::Indexer requires that the XML Builder library be installed:" \
+            "\n\tgem install builder"
+    end
+
+    options = { :build_modern => true }.merge options
+
+    @build_modern = options[:build_modern]
+
+    @dest_directory = directory
+    @directory = Dir.mktmpdir "gem_generate_index"
+
+    marshal_name = "Marshal.#{Gem.marshal_version}"
+
+    @master_index = File.join @directory, "yaml"
+    @marshal_index = File.join @directory, marshal_name
+
+    @quick_dir = File.join @directory, "quick"
+    @quick_marshal_dir = File.join @quick_dir, marshal_name
+    @quick_marshal_dir_base = File.join "quick", marshal_name # FIX: UGH
+
+    @quick_index = File.join @quick_dir, "index"
+    @latest_index = File.join @quick_dir, "latest_index"
+
+    @specs_index = File.join @directory, "specs.#{Gem.marshal_version}"
+    @latest_specs_index =
+      File.join(@directory, "latest_specs.#{Gem.marshal_version}")
+    @prerelease_specs_index =
+      File.join(@directory, "prerelease_specs.#{Gem.marshal_version}")
+    @dest_specs_index =
+      File.join(@dest_directory, "specs.#{Gem.marshal_version}")
+    @dest_latest_specs_index =
+      File.join(@dest_directory, "latest_specs.#{Gem.marshal_version}")
+    @dest_prerelease_specs_index =
+      File.join(@dest_directory, "prerelease_specs.#{Gem.marshal_version}")
+
+    @files = []
+  end
+
+  ##
+  # Build various indices
+
+  def build_indices
+    specs = map_gems_to_specs gem_file_list
+    Gem::Specification._resort! specs
+    build_marshal_gemspecs specs
+    build_modern_indices specs if @build_modern
+
+    compress_indices
+  end
+
+  ##
+  # Builds Marshal quick index gemspecs.
+
+  def build_marshal_gemspecs(specs)
+    count = specs.count
+    progress = ui.progress_reporter count,
+                                    "Generating Marshal quick index gemspecs for #{count} gems",
+                                    "Complete"
+
+    files = []
+
+    Gem.time "Generated Marshal quick index gemspecs" do
+      specs.each do |spec|
+        next if spec.default_gem?
+        spec_file_name = "#{spec.original_name}.gemspec.rz"
+        marshal_name = File.join @quick_marshal_dir, spec_file_name
+
+        marshal_zipped = Gem.deflate Marshal.dump(spec)
+
+        File.open marshal_name, "wb" do |io|
+          io.write marshal_zipped
+        end
+
+        files << marshal_name
+
+        progress.updated spec.original_name
+      end
+
+      progress.done
+    end
+
+    @files << @quick_marshal_dir
+
+    files
+  end
+
+  ##
+  # Build a single index for RubyGems 1.2 and newer
+
+  def build_modern_index(index, file, name)
+    say "Generating #{name} index"
+
+    Gem.time "Generated #{name} index" do
+      File.open(file, "wb") do |io|
+        specs = index.map do |*spec|
+          # We have to splat here because latest_specs is an array, while the
+          # others are hashes.
+          spec = spec.flatten.last
+          platform = spec.original_platform
+
+          # win32-api-1.0.4-x86-mswin32-60
+          unless String === platform
+            alert_warning "Skipping invalid platform in gem: #{spec.full_name}"
+            next
+          end
+
+          platform = Gem::Platform::RUBY if platform.nil? || platform.empty?
+          [spec.name, spec.version, platform]
+        end
+
+        specs = compact_specs(specs)
+        Marshal.dump(specs, io)
+      end
+    end
+  end
+
+  ##
+  # Builds indices for RubyGems 1.2 and newer. Handles full, latest, prerelease
+
+  def build_modern_indices(specs)
+    prerelease, released = specs.partition do |s|
+      s.version.prerelease?
+    end
+    latest_specs =
+      Gem::Specification._latest_specs specs
+
+    build_modern_index(released.sort, @specs_index, "specs")
+    build_modern_index(latest_specs.sort, @latest_specs_index, "latest specs")
+    build_modern_index(prerelease.sort, @prerelease_specs_index,
+                       "prerelease specs")
+
+    @files += [@specs_index,
+               "#{@specs_index}.gz",
+               @latest_specs_index,
+               "#{@latest_specs_index}.gz",
+               @prerelease_specs_index,
+               "#{@prerelease_specs_index}.gz"]
+  end
+
+  def map_gems_to_specs(gems)
+    gems.map do |gemfile|
+      if File.size(gemfile) == 0
+        alert_warning "Skipping zero-length gem: #{gemfile}"
+        next
+      end
+
+      begin
+        spec = Gem::Package.new(gemfile).spec
+        spec.loaded_from = gemfile
+
+        spec.abbreviate
+        spec.sanitize
+
+        spec
+      rescue SignalException
+        alert_error "Received signal, exiting"
+        raise
+      rescue StandardError => e
+        msg = ["Unable to process #{gemfile}",
+               "#{e.message} (#{e.class})",
+               "\t#{e.backtrace.join "\n\t"}"].join("\n")
+        alert_error msg
+      end
+    end.compact
+  end
+
+  ##
+  # Compresses indices on disk
+  #--
+  # All future files should be compressed using gzip, not deflate
+
+  def compress_indices
+    say "Compressing indices"
+
+    Gem.time "Compressed indices" do
+      if @build_modern
+        gzip @specs_index
+        gzip @latest_specs_index
+        gzip @prerelease_specs_index
+      end
+    end
+  end
+
+  ##
+  # Compacts Marshal output for the specs index data source by using identical
+  # objects as much as possible.
+
+  def compact_specs(specs)
+    names = {}
+    versions = {}
+    platforms = {}
+
+    specs.map do |(name, version, platform)|
+      names[name] = name unless names.include? name
+      versions[version] = version unless versions.include? version
+      platforms[platform] = platform unless platforms.include? platform
+
+      [names[name], versions[version], platforms[platform]]
+    end
+  end
+
+  ##
+  # Compress +filename+ with +extension+.
+
+  def compress(filename, extension)
+    data = Gem.read_binary filename
+
+    zipped = Gem.deflate data
+
+    File.open "#{filename}.#{extension}", "wb" do |io|
+      io.write zipped
+    end
+  end
+
+  ##
+  # List of gem file names to index.
+
+  def gem_file_list
+    Gem::Util.glob_files_in_dir("*.gem", File.join(@dest_directory, "gems"))
+  end
+
+  ##
+  # Builds and installs indices.
+
+  def generate_index
+    make_temp_directories
+    build_indices
+    install_indices
+  rescue SignalException
+  ensure
+    FileUtils.rm_rf @directory
+  end
+
+  ##
+  # Zlib::GzipWriter wrapper that gzips +filename+ on disk.
+
+  def gzip(filename)
+    Zlib::GzipWriter.open "#{filename}.gz" do |io|
+      io.write Gem.read_binary(filename)
+    end
+  end
+
+  ##
+  # Install generated indices into the destination directory.
+
+  def install_indices
+    verbose = Gem.configuration.really_verbose
+
+    say "Moving index into production dir #{@dest_directory}" if verbose
+
+    files = @files
+    files.delete @quick_marshal_dir if files.include? @quick_dir
+
+    if files.include?(@quick_marshal_dir) && !files.include?(@quick_dir)
+      files.delete @quick_marshal_dir
+
+      dst_name = File.join(@dest_directory, @quick_marshal_dir_base)
+
+      FileUtils.mkdir_p File.dirname(dst_name), :verbose => verbose
+      FileUtils.rm_rf dst_name, :verbose => verbose
+      FileUtils.mv(@quick_marshal_dir, dst_name,
+                   :verbose => verbose, :force => true)
+    end
+
+    files = files.map do |path|
+      path.sub(%r{^#{Regexp.escape @directory}/?}, "") # HACK?
+    end
+
+    files.each do |file|
+      src_name = File.join @directory, file
+      dst_name = File.join @dest_directory, file
+
+      FileUtils.rm_rf dst_name, :verbose => verbose
+      FileUtils.mv(src_name, @dest_directory,
+                   :verbose => verbose, :force => true)
+    end
+  end
+
+  ##
+  # Make directories for index generation
+
+  def make_temp_directories
+    FileUtils.rm_rf @directory
+    FileUtils.mkdir_p @directory, :mode => 0o700
+    FileUtils.mkdir_p @quick_marshal_dir
+  end
+
+  ##
+  # Ensure +path+ and path with +extension+ are identical.
+
+  def paranoid(path, extension)
+    data = Gem.read_binary path
+    compressed_data = Gem.read_binary "#{path}.#{extension}"
+
+    unless data == Gem::Util.inflate(compressed_data)
+      raise "Compressed file #{compressed_path} does not match uncompressed file #{path}"
+    end
+  end
+
+  ##
+  # Perform an in-place update of the repository from newly added gems.
+
+  def update_index
+    make_temp_directories
+
+    specs_mtime = File.stat(@dest_specs_index).mtime
+    newest_mtime = Time.at 0
+
+    updated_gems = gem_file_list.select do |gem|
+      gem_mtime = File.stat(gem).mtime
+      newest_mtime = gem_mtime if gem_mtime > newest_mtime
+      gem_mtime >= specs_mtime
+    end
+
+    if updated_gems.empty?
+      say "No new gems"
+      terminate_interaction 0
+    end
+
+    specs = map_gems_to_specs updated_gems
+    prerelease, released = specs.partition {|s| s.version.prerelease? }
+
+    files = build_marshal_gemspecs specs
+
+    Gem.time "Updated indexes" do
+      update_specs_index released, @dest_specs_index, @specs_index
+      update_specs_index released, @dest_latest_specs_index, @latest_specs_index
+      update_specs_index(prerelease,
+                         @dest_prerelease_specs_index,
+                         @prerelease_specs_index)
+    end
+
+    compress_indices
+
+    verbose = Gem.configuration.really_verbose
+
+    say "Updating production dir #{@dest_directory}" if verbose
+
+    files << @specs_index
+    files << "#{@specs_index}.gz"
+    files << @latest_specs_index
+    files << "#{@latest_specs_index}.gz"
+    files << @prerelease_specs_index
+    files << "#{@prerelease_specs_index}.gz"
+
+    files = files.map do |path|
+      path.sub(%r{^#{Regexp.escape @directory}/?}, "") # HACK?
+    end
+
+    files.each do |file|
+      src_name = File.join @directory, file
+      dst_name = File.join @dest_directory, file # REFACTOR: duped above
+
+      FileUtils.mv src_name, dst_name, :verbose => verbose,
+                                       :force => true
+
+      File.utime newest_mtime, newest_mtime, dst_name
+    end
+  ensure
+    FileUtils.rm_rf @directory
+  end
+
+  ##
+  # Combines specs in +index+ and +source+ then writes out a new copy to
+  # +dest+.  For a latest index, does not ensure the new file is minimal.
+
+  def update_specs_index(index, source, dest)
+    specs_index = marshal_load Gem.read_binary(source)
+
+    index.each do |spec|
+      platform = spec.original_platform
+      platform = Gem::Platform::RUBY if platform.nil? || platform.empty?
+      specs_index << [spec.name, spec.version, platform]
+    end
+
+    specs_index = compact_specs specs_index.uniq.sort
+
+    File.open dest, "wb" do |io|
+      Marshal.dump specs_index, io
+    end
+  end
+
+  private
+
+  def marshal_load(string)
+    if Gem.respond_to?(:load_safe_marshal)
+      Gem.load_safe_marshal
+      Gem::SafeMarshal.safe_load string
+    else
+      Marshal.load string
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubygems/command_manager"
+require_relative "rubygems/commands/generate_index_command"
+
+Gem::CommandManager.instance.register_command :generate_index

data/rubygems-generate_index.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name = "rubygems-generate_index"
+  s.version = "1.0.0"
+  s.authors = ["Jim Weirich", "Chad Fowler", "Eric Hodel", "Luis Lavena", "Aaron Patterson", "Samuel Giddins", "André Arko", "Evan Phoenix", "Hiroshi SHIBATA"]
+  s.email = ["", "", "drbrain@segment7.net", "luislavena@gmail.com", "aaron@tenderlovemaking.com", "segiddins@segiddins.me", "andre@arko.net", "evan@phx.io", "hsbt@ruby-lang.org"]
+
+  s.summary = "Generates the index files for a gem server directory"
+  s.homepage = "https://github.com/rubygems/rubygems-generate_index"
+
+  s.metadata["homepage_uri"] = s.homepage
+  s.metadata["source_code_uri"] = "https://github.com/rubygems/rubygems-generate_index"
+  s.metadata["changelog_uri"] = "https://github.com/rubygems/rubygems-generate_index"
+
+  s.licenses = ["Ruby", "MIT"]
+
+  s.files = File.read("Manifest.txt").split
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rdoc_options = ["--main", "README.md", "--title=RubyGems Generate Index Documentation"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "MIT.txt", "Manifest.txt", "README.md",
+    "CODE_OF_CONDUCT.md"
+  ]
+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  s.required_rubygems_version = Gem::Requirement.new(">= 0")
+
+  s.add_dependency "compact_index", "~> 0.14.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rubygems-generate_index
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jim Weirich
+- Chad Fowler
+- Eric Hodel
+- Luis Lavena
+- Aaron Patterson
+- Samuel Giddins
+- André Arko
+- Evan Phoenix
+- Hiroshi SHIBATA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: compact_index
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: 
+email:
+- ''
+- ''
+- drbrain@segment7.net
+- luislavena@gmail.com
+- aaron@tenderlovemaking.com
+- segiddins@segiddins.me
+- andre@arko.net
+- evan@phx.io
+- hsbt@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- MIT.txt
+- Manifest.txt
+- README.md
+- CODE_OF_CONDUCT.md
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- MIT.txt
+- Manifest.txt
+- README.md
+- lib/rubygems/commands/generate_index_command.rb
+- lib/rubygems/indexer.rb
+- lib/rubygems_plugin.rb
+- rubygems-generate_index.gemspec
+homepage: https://github.com/rubygems/rubygems-generate_index
+licenses:
+- Ruby
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubygems/rubygems-generate_index
+  source_code_uri: https://github.com/rubygems/rubygems-generate_index
+  changelog_uri: https://github.com/rubygems/rubygems-generate_index
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+- "--title=RubyGems Generate Index Documentation"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Generates the index files for a gem server directory
+test_files: []