Merge pull request #32162 from kaspth/ast-unify-preview-variant-routes-and-controllers

Merge Previews/Variants controller into one Representations controller.

activestorage/app/controllers/active_storage/previews_controller.rb

-# frozen_string_literal: true
-
-class ActiveStorage::PreviewsController < ActionController::Base
-  include ActiveStorage::SetBlob
-
-  def show
-    expires_in ActiveStorage::Blob.service.url_expires_in
-    redirect_to ActiveStorage::Preview.new(@blob, params[:variation_key]).processed.service_url(disposition: params[:disposition])
-  end
-end

activestorage/app/controllers/active_storage/variants_controller.rb → activestorage/app/controllers/active_storage/representations_controller.rb

 # frozen_string_literal: true
 
-# Take a signed permanent reference for a variant and turn it into an expiring service URL for download.
+# Take a signed permanent reference for a blob representation and turn it into an expiring service URL for download.
 # Note: These URLs are publicly accessible. If you need to enforce access protection beyond the
 # security-through-obscurity factor of the signed blob and variation reference, you'll need to implement your own
 # authenticated redirection controller.
-class ActiveStorage::VariantsController < ActionController::Base
+class ActiveStorage::RepresentationsController < ActionController::Base
   include ActiveStorage::SetBlob
 
   def show
     expires_in ActiveStorage::Blob.service.url_expires_in
-    redirect_to ActiveStorage::Variant.new(@blob, params[:variation_key]).processed.service_url(disposition: params[:disposition])
+    redirect_to @blob.representation(params[:variation_key]).processed.service_url(disposition: params[:disposition])
   end
 end

activestorage/app/models/active_storage/blob/representable.rb

@@ -27,7 +27,7 @@ module ActiveStorage::Blob::Representable
   # variable, call ActiveStorage::Blob#variable?.
   def variant(transformations)
     if variable?
-      ActiveStorage::Variant.new(self, ActiveStorage::Variation.wrap(transformations))
+      ActiveStorage::Variant.new(self, transformations)
     else
       raise ActiveStorage::InvariableError
     end
@@ -55,7 +55,7 @@ def variable?
   # whether a blob is accepted by any previewer, call ActiveStorage::Blob#previewable?.
   def preview(transformations)
     if previewable?
-      ActiveStorage::Preview.new(self, ActiveStorage::Variation.wrap(transformations))
+      ActiveStorage::Preview.new(self, transformations)
     else
       raise ActiveStorage::UnpreviewableError
     end

activestorage/config/routes.rb

@@ -11,30 +11,18 @@
   resolve("ActiveStorage::Attachment") { |attachment, options| route_for(:rails_blob, attachment.blob, options) }
 
 
-  get "/rails/active_storage/variants/:signed_blob_id/:variation_key/*filename" => "active_storage/variants#show", as: :rails_blob_variation
+  get "/rails/active_storage/representations/:signed_blob_id/:variation_key/*filename" => "active_storage/representations#show", as: :rails_blob_representation
 
-  direct :rails_variant do |variant, options|
-    signed_blob_id = variant.blob.signed_id
-    variation_key  = variant.variation.key
-    filename       = variant.blob.filename
+  direct :rails_representation do |representation, options|
+    signed_blob_id = representation.blob.signed_id
+    variation_key  = representation.variation.key
+    filename       = representation.blob.filename
 
-    route_for(:rails_blob_variation, signed_blob_id, variation_key, filename, options)
+    route_for(:rails_blob_representation, signed_blob_id, variation_key, filename, options)
   end
 
-  resolve("ActiveStorage::Variant") { |variant, options| route_for(:rails_variant, variant, options) }
-
-
-  get "/rails/active_storage/previews/:signed_blob_id/:variation_key/*filename" => "active_storage/previews#show", as: :rails_blob_preview
-
-  direct :rails_preview do |preview, options|
-    signed_blob_id = preview.blob.signed_id
-    variation_key  = preview.variation.key
-    filename       = preview.blob.filename
-
-    route_for(:rails_blob_preview, signed_blob_id, variation_key, filename, options)
-  end
-
-  resolve("ActiveStorage::Preview") { |preview, options| route_for(:rails_preview, preview, options) }
+  resolve("ActiveStorage::Variant") { |variant, options| route_for(:rails_representation, variant, options) }
+  resolve("ActiveStorage::Preview") { |preview, options| route_for(:rails_representation, preview, options) }
 
 
   get  "/rails/active_storage/disk/:encoded_key/*filename" => "active_storage/disk#show", as: :rails_disk_service

activestorage/test/controllers/previews_controller_test.rb → activestorage/test/controllers/representations_controller_test.rb

@@ -3,13 +3,41 @@
 require "test_helper"
 require "database/setup"
 
-class ActiveStorage::PreviewsControllerTest < ActionDispatch::IntegrationTest
+class ActiveStorage::RepresentationsControllerWithVariantsTest < ActionDispatch::IntegrationTest
+  setup do
+    @blob = create_file_blob filename: "racecar.jpg"
+  end
+
+  test "showing variant inline" do
+    get rails_blob_representation_url(
+      filename: @blob.filename,
+      signed_blob_id: @blob.signed_id,
+      variation_key: ActiveStorage::Variation.encode(resize: "100x100"))
+
+    assert_redirected_to(/racecar\.jpg\?.*disposition=inline/)
+
+    image = read_image(@blob.variant(resize: "100x100"))
+    assert_equal 100, image.width
+    assert_equal 67, image.height
+  end
+
+  test "showing variant with invalid signed blob ID" do
+    get rails_blob_representation_url(
+      filename: @blob.filename,
+      signed_blob_id: "invalid",
+      variation_key: ActiveStorage::Variation.encode(resize: "100x100"))
+
+    assert_response :not_found
+  end
+end
+
+class ActiveStorage::RepresentationsControllerWithPreviewsTest < ActionDispatch::IntegrationTest
   setup do
     @blob = create_file_blob filename: "report.pdf", content_type: "application/pdf"
   end
 
   test "showing preview inline" do
-    get rails_blob_preview_url(
+    get rails_blob_representation_url(
       filename: @blob.filename,
       signed_blob_id: @blob.signed_id,
       variation_key: ActiveStorage::Variation.encode(resize: "100x100"))
@@ -23,7 +51,7 @@ class ActiveStorage::PreviewsControllerTest < ActionDispatch::IntegrationTest
   end
 
   test "showing preview with invalid signed blob ID" do
-    get rails_blob_preview_url(
+    get rails_blob_representation_url(
       filename: @blob.filename,
       signed_blob_id: "invalid",
       variation_key: ActiveStorage::Variation.encode(resize: "100x100"))

activestorage/test/controllers/variants_controller_test.rb

-# frozen_string_literal: true
-
-require "test_helper"
-require "database/setup"
-
-class ActiveStorage::VariantsControllerTest < ActionDispatch::IntegrationTest
-  setup do
-    @blob = create_file_blob filename: "racecar.jpg"
-  end
-
-  test "showing variant inline" do
-    get rails_blob_variation_url(
-      filename: @blob.filename,
-      signed_blob_id: @blob.signed_id,
-      variation_key: ActiveStorage::Variation.encode(resize: "100x100"))
-
-    assert_redirected_to(/racecar\.jpg\?.*disposition=inline/)
-
-    image = read_image(@blob.variant(resize: "100x100"))
-    assert_equal 100, image.width
-    assert_equal 67, image.height
-  end
-
-  test "showing variant with invalid signed blob ID" do
-    get rails_blob_variation_url(
-      filename: @blob.filename,
-      signed_blob_id: "invalid",
-      variation_key: ActiveStorage::Variation.encode(resize: "100x100"))
-
-    assert_response :not_found
-  end
-end