Add Version#gem_file_name.

- to keep the logic in one place
rubygems · Oct 17, 2023 · ceb66c8 · ceb66c8
1 parent b56629f
commit ceb66c8
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 14 deletions.
diff --git a/app/jobs/store_version_contents_job.rb b/app/jobs/store_version_contents_job.rb
@@ -27,8 +27,8 @@ def perform(version:)
     raise VersionNotIndexed, "Version #{version&.full_name.inspect} is not indexed" unless version&.indexed?
     logger.info "Storing gem contents for #{version.full_name}"
 
-    gem = RubygemFs.instance.get("gems/#{version.full_name}.gem")
-    raise GemNotFound, "Gem file not found: #{version.full_name}.gem" unless gem
+    gem = RubygemFs.instance.get("gems/#{version.gem_file_name}")
+    raise GemNotFound, "Gem file not found: #{version.gem_file_name}" unless gem
 
     package = Gem::Package.new(StringIO.new(gem))
     version.manifest.store_package package

diff --git a/app/models/concerns/rubygem_searchable.rb b/app/models/concerns/rubygem_searchable.rb
@@ -47,7 +47,7 @@ def search_data # rubocop:disable Metrics/MethodLength
         metadata:          latest_version&.metadata,
         sha:               latest_version&.sha256_hex,
         project_uri:       "#{Gemcutter::PROTOCOL}://#{Gemcutter::HOST}/gems/#{name}",
-        gem_uri:           "#{Gemcutter::PROTOCOL}://#{Gemcutter::HOST}/gems/#{latest_version&.full_name}.gem",
+        gem_uri:           "#{Gemcutter::PROTOCOL}://#{Gemcutter::HOST}/gems/#{latest_version&.gem_file_name}",
         homepage_uri:      versioned_links&.homepage_uri,
         wiki_uri:          versioned_links&.wiki_uri,
         documentation_uri: versioned_links&.documentation_uri,

diff --git a/app/models/deletion.rb b/app/models/deletion.rb
@@ -72,13 +72,13 @@ def reindex
 
   def remove_from_storage
     RubygemFs.instance.remove(
-      "gems/#{version.full_name}.gem",
+      "gems/#{version.gem_file_name}",
       "quick/Marshal.4.8/#{version.full_name}.gemspec.rz"
     )
   end
 
   def restore_to_storage
-    RubygemFs.instance.restore("gems/#{version.full_name}.gem")
+    RubygemFs.instance.restore("gems/#{version.gem_file_name}")
     RubygemFs.instance.restore("quick/Marshal.4.8/#{version.full_name}.gemspec.rz")
   end
 
@@ -91,7 +91,7 @@ def restore_version_contents
   end
 
   def purge_fastly
-    FastlyPurgeJob.perform_later(path: "gems/#{version.full_name}.gem", soft: false)
+    FastlyPurgeJob.perform_later(path: "gems/#{version.gem_file_name}", soft: false)
     FastlyPurgeJob.perform_later(path: "quick/Marshal.4.8/#{version.full_name}.gemspec.rz", soft: false)
   end
 

diff --git a/app/models/links.rb b/app/models/links.rb
@@ -56,7 +56,7 @@ def documentation_uri
 
   # technically this is a path
   def download_uri
-    "/downloads/#{version.full_name}.gem" if version.indexed
+    "/downloads/#{version.gem_file_name}" if version.indexed
   end
 
   # excluded from metadata_uri_set? check

diff --git a/app/models/pusher.rb b/app/models/pusher.rb
@@ -235,14 +235,12 @@ def version_mfa_required?
     ActiveRecord::Type::Boolean.new.cast(spec.metadata["rubygems_mfa_required"])
   end
 
+  # we validate that the version full_name == spec.original_name
   def write_gem(body, spec_contents)
-    # we validate that the version full_name == spec.original_name
-    original_name = @version.full_name
-
-    gem_path = "gems/#{original_name}.gem"
+    gem_path = "gems/#{@version.gem_file_name}"
     gem_contents = body.string
 
-    spec_path = "quick/Marshal.4.8/#{original_name}.gemspec.rz"
+    spec_path = "quick/Marshal.4.8/#{@version.full_name}.gemspec.rz"
 
     # do all processing _before_ we upload anything to S3, so we lower the chances of orphaned files
     RubygemFs.instance.store(gem_path, gem_contents, checksum_sha256: version.sha256)

diff --git a/app/models/rubygem.rb b/app/models/rubygem.rb
@@ -213,7 +213,7 @@ def payload(version = most_recent_version, protocol = Gemcutter::PROTOCOL, host_
       "yanked"             => version.yanked?,
       "sha"                => version.sha256_hex,
       "project_uri"        => "#{protocol}://#{host_with_port}/gems/#{name}",
-      "gem_uri"            => "#{protocol}://#{host_with_port}/gems/#{version.full_name}.gem",
+      "gem_uri"            => "#{protocol}://#{host_with_port}/gems/#{version.gem_file_name}",
       "homepage_uri"       => versioned_links.homepage_uri,
       "wiki_uri"           => versioned_links.wiki_uri,
       "documentation_uri"  => versioned_links.documentation_uri,

diff --git a/app/models/version.rb b/app/models/version.rb
@@ -408,6 +408,10 @@ def manifest
     rubygem.version_manifest(number, platformed? ? platform : nil)
   end
 
+  def gem_file_name
+    "#{full_name}.gem"
+  end
+
   private
 
   def update_prerelease

diff --git a/app/tasks/maintenance/verify_gem_contents_in_fs_task.rb b/app/tasks/maintenance/verify_gem_contents_in_fs_task.rb
@@ -26,7 +26,7 @@ def collection
 
   def process(version)
     logger.tagged(version_id: version.id, name: version.rubygem.name, number: version.number, platform: version.platform) do
-      gem_path = "gems/#{version.full_name}.gem"
+      gem_path = "gems/#{version.gem_file_name}"
       spec_path = "quick/Marshal.4.8/#{version.full_name}.gemspec.rz"
 
       expected_checksum = version.sha256

diff --git a/test/models/version_test.rb b/test/models/version_test.rb
@@ -453,6 +453,12 @@ class VersionTest < ActiveSupport::TestCase
       assert_equal @version.number, @version.slug
     end
 
+    should "compose gem_file_name" do
+      @version.full_name = "abc-1.1.1"
+
+      assert_equal "abc-1.1.1.gem", @version.gem_file_name
+    end
+
     should "raise an ActiveRecord::RecordNotFound if an invalid slug is given" do
       assert_raise ActiveRecord::RecordNotFound do
         @version.rubygem.find_version!(number: "some stupid version 399", platform: @version.platform)