resizing 1.2.1 → 1.3.1

data/test/resizing/carrier_wave_test.rb

@@ -5,20 +5,13 @@ require 'test_helper'
 module Resizing
   class CarrierWaveTest < Minitest::Test
     include VCRRequestAssertions
+    include ResizingTestConfiguration
 
     def setup
       TestModel.delete_all
       TestJPGModel.delete_all
 
-      @configuration_template = {
-        image_host: 'http://192.168.56.101:5000',
-        video_host: 'http://192.168.56.101:5000',
-        project_id: 'e06e710d-f026-4dcf-b2c0-eab0de8bb83f',
-        secret_token: 'ewbym2r1pk49x1d2lxdbiiavnqp25j2kh00hsg3koy0ppm620x5mhlmgl3rq5ci8',
-        open_timeout: 10,
-        response_timeout: 20
-      }
-      Resizing.configure = @configuration_template
+      configure_resizing
     end
 
     def teardown; end
@@ -163,25 +156,486 @@ module Resizing
       assert_instance_of Resizing::CarrierWave::Storage::File, file
     end
 
-    def expect_url
-      'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/' \
-        'upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+    def prepare_model(model_class)
+      result = nil
+      VCR.use_cassette 'carrier_wave_test/save', record: :once do
+        result = model_class.new
+        attach_sample_image(result)
+      end
+      result
     end
 
-    def prepare_model(model)
-      result = nil
+    # TestModelWithCallbackTracking 用のヘルパーメソッド
+    def prepare_tracking_model
+      prepare_model(TestModelWithCallbackTracking)
+    end
+
+    # 既存モデルに新しい画像をアップロードするヘルパーメソッド
+    def upload_new_image(model)
       VCR.use_cassette 'carrier_wave_test/save', record: :once do
-        result = model.new
-        file = File.open('test/data/images/sample1.jpg', 'r')
-        uploaded_file = ActionDispatch::Http::UploadedFile.new(
-          filename: File.basename(file.path),
-          type: 'image/jpeg',
-          tempfile: file
-        )
+        attach_sample_image(model)
+      end
+    end
+
+    # after_commit コールバックが正しく呼ばれることを確認するテスト
+    # 通常のテスト環境ではトランザクションが使われるため、after_commit が呼ばれない問題がある
+    # このテストでは、明示的にトランザクションをコミットして after_commit が呼ばれることを確認する
 
-        result.resizing_picture = uploaded_file
+    def test_after_commit_callback_is_called_on_create
+      # after_commit on: :create が呼ばれることを確認
+      model = prepare_tracking_model
+
+      # 明示的なトランザクション内で save! することで after_commit が呼ばれる
+      ActiveRecord::Base.transaction do
+        model.save!
       end
-      result
+
+      assert_includes model.callback_log, :create_commit,
+                      'after_commit on: :create should be called after transaction commit'
+    end
+
+    def test_after_commit_callback_is_called_on_update
+      # after_commit on: :update が呼ばれることを確認
+      model = prepare_tracking_model
+      model.save!
+      model.callback_log.clear
+
+      # 更新時の after_commit が呼ばれることを確認
+      upload_new_image(model)
+
+      ActiveRecord::Base.transaction do
+        model.save!
+      end
+
+      assert_includes model.callback_log, :update_commit,
+                      'after_commit on: :update should be called after transaction commit'
+    end
+
+    def test_after_commit_callback_is_called_on_destroy
+      # after_commit on: :destroy が呼ばれることを確認
+      model = prepare_tracking_model
+      model.save!
+      model.callback_log.clear
+
+      # destroy 時の after_commit が呼ばれることを確認
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          model.destroy!
+        end
+      end
+
+      assert_includes model.callback_log, :destroy_commit,
+                      'after_commit on: :destroy should be called after transaction commit'
+    end
+
+    def test_carrierwave_remove_previously_stored_is_called_on_update
+      # CarrierWave が登録する remove_previously_stored_#{column} が
+      # 画像の更新時に呼ばれることを確認
+      model = prepare_model TestModel
+      model.save!
+
+      model.resizing_picture_url
+
+      # 新しい画像をアップロードして更新
+      upload_new_image(model)
+
+      # 更新時には古い画像を削除するため DELETE リクエストが発行されるべき
+      # ただし、同じカセットを使用しているため同じ URL になる
+      # 実際の環境では異なる public_id が返されるため、古い画像が削除される
+      ActiveRecord::Base.transaction do
+        model.save!
+      end
+
+      # モデルが更新されたことを確認
+      refute_nil model.resizing_picture_url
+    end
+
+    def test_delete_is_called_when_image_is_updated
+      # 画像更新時に古い画像を削除する DELETE リクエストが発行されることを確認
+      # VCR カセット update_image.yml には以下が含まれる:
+      # 1. POST (古い画像のアップロード) -> old-image-id を返す
+      # 2. POST (新しい画像のアップロード) -> new-image-id を返す
+      # 3. DELETE (古い画像の削除) -> old-image-id を削除
+
+      assert_vcr_requests_made 'carrier_wave_test/update_image' do
+        model = TestModel.new
+        model.resizing_picture = File.open(File.expand_path('../data/images/sample1.jpg', __dir__))
+        model.save!
+
+        old_public_id = model.read_attribute(:resizing_picture)
+        assert_match(/old-image-id/, old_public_id)
+
+        # 新しい画像をアップロードして更新（同じカセット内で）
+        model.resizing_picture = File.open(File.expand_path('../data/images/sample1.jpg', __dir__))
+
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+
+        # 更新後は新しい画像の public_id が設定されている
+        new_public_id = model.read_attribute(:resizing_picture)
+        assert_match(/new-image-id/, new_public_id)
+      end
+      # カセット内の全リクエスト（POST x2, DELETE x1）が発行されたことを確認
+    end
+
+    # ============================================================
+    # before_save / after_save コールバックのテスト
+    # ============================================================
+
+    def test_before_save_write_identifier_is_called
+      # before_save :write_#{column}_identifier が呼ばれ、
+      # カラムに識別子が書き込まれることを確認
+      model = prepare_model TestModel
+
+      # 保存前は識別子がDBに書き込まれていない
+      assert model.new_record?
+
+      model.save!
+
+      # 保存後は識別子がDBに書き込まれている
+      assert_match %r{/projects/.+/upload/images/.+}, model.read_attribute(:resizing_picture)
+    end
+
+    def test_after_save_store_is_called
+      # after_save :store_#{column}! が呼ばれ、
+      # ファイルがストレージに保存されることを確認
+      model = prepare_model TestModel
+      model.save!
+
+      # ファイルが保存され、URLが取得できることを確認
+      refute_nil model.resizing_picture_url
+      refute model.resizing_picture.blank?
+    end
+
+    def test_after_save_store_previous_changes_is_called
+      # after_save :store_previous_changes_for_#{column} が呼ばれ、
+      # 前の変更が追跡されることを確認
+      model = prepare_model TestModel
+      model.save!
+
+      model.read_attribute(:resizing_picture)
+
+      # 新しい画像をアップロード
+      upload_new_image(model)
+
+      model.save!
+
+      # previous_changes に resizing_picture の変更が記録されていることを確認
+      # (CarrierWave が store_previous_changes_for_#{column} で追跡)
+      assert model.previous_changes.key?('resizing_picture'),
+             'previous_changes should track resizing_picture changes'
+    end
+
+    # ============================================================
+    # after_commit :mark_remove_#{column}_false のテスト
+    # ============================================================
+
+    def test_mark_remove_column_false_is_called_after_update
+      # after_commit :mark_remove_#{column}_false, on: :update が呼ばれ、
+      # remove フラグがリセットされることを確認
+      model = prepare_model TestModel
+      model.save!
+
+      # remove フラグを設定
+      model.remove_resizing_picture = '1'
+
+      # この時点ではフラグが設定されている
+      assert_equal '1', model.remove_resizing_picture
+
+      # save 後に after_commit で mark_remove_resizing_picture_false が呼ばれる
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+      end
+
+      # after_commit 後はフラグがリセットされている
+      # CarrierWave が mark_remove_#{column}_false でフラグをリセット
+      refute model.remove_resizing_picture,
+             'remove flag should be reset after commit'
+    end
+
+    # ============================================================
+    # after_commit :remove_#{column}!, on: :destroy のテスト
+    # ============================================================
+
+    def test_remove_column_is_called_on_destroy
+      # after_commit :remove_#{column}!, on: :destroy が呼ばれ、
+      # ファイルが削除されることを確認
+      model = prepare_model TestModel
+      model.save!
+
+      refute model.resizing_picture.blank?
+
+      # destroy 時に DELETE リクエストが発行されることを確認
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          model.destroy!
+        end
+      end
+
+      # モデルが削除されたことを確認
+      assert model.destroyed?
+    end
+
+    # ============================================================
+    # コールバック順序のテスト
+    # ============================================================
+
+    def test_callback_order_on_create
+      # create 時のコールバック順序を確認
+      # 1. before_save :write_#{column}_identifier
+      # 2. after_save :store_#{column}!
+      # 3. after_commit (on: :create)
+      model = prepare_tracking_model
+
+      ActiveRecord::Base.transaction do
+        model.save!
+      end
+
+      # コールバックが正しい順序で呼ばれたことを確認
+      assert_equal %i[before_save after_save create_commit], model.callback_log
+    end
+
+    def test_callback_order_on_update
+      # update 時のコールバック順序を確認
+      # 1. before_save :write_#{column}_identifier
+      # 2. after_save :store_#{column}!
+      # 3. after_save :store_previous_changes_for_#{column}
+      # 4. after_commit :mark_remove_#{column}_false
+      # 5. after_commit :remove_previously_stored_#{column}
+      model = prepare_tracking_model
+      model.save!
+      model.callback_log.clear
+
+      # 更新
+      upload_new_image(model)
+
+      ActiveRecord::Base.transaction do
+        model.save!
+      end
+
+      # コールバックが正しい順序で呼ばれたことを確認
+      assert_equal %i[before_save after_save update_commit], model.callback_log
+    end
+
+    def test_callback_order_on_destroy
+      # destroy 時のコールバック順序を確認
+      # 1. before_destroy
+      # 2. after_destroy
+      # 3. after_commit :remove_#{column}!, on: :destroy
+      model = prepare_tracking_model
+      model.save!
+      model.callback_log.clear
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          model.destroy!
+        end
+      end
+
+      # コールバックが正しい順序で呼ばれたことを確認
+      assert_equal %i[before_destroy after_destroy destroy_commit], model.callback_log
+    end
+
+    # ============================================================
+    # DB から再読込したモデルに対する操作 (retrieve_from_store! 経由)
+    # ============================================================
+
+    def test_url_of_freshly_loaded_model_matches_saved_url
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_equal "#{expect_url}/", loaded.resizing_picture_url
+      assert_equal "#{expect_url}/c_fill,w_40,h_40", loaded.resizing_picture_url(:small)
+      refute loaded.resizing_picture.blank?
+    end
+
+    def test_remove_on_freshly_loaded_model_deletes_remote_image_and_clears_column
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        loaded.remove_resizing_picture!
+        loaded.save!
+      end
+
+      assert_nil loaded.read_attribute(:resizing_picture)
+      assert_nil loaded.resizing_picture_url
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_remove_flag_on_freshly_loaded_model_deletes_remote_image_and_clears_column
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+      loaded.remove_resizing_picture = true
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        loaded.save!
+      end
+
+      assert loaded.resizing_picture.blank?
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_destroy_on_freshly_loaded_model_deletes_remote_image
+      model = prepare_model TestModel
+      model.save!
+
+      loaded = TestModel.find(model.id)
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        ActiveRecord::Base.transaction do
+          loaded.destroy!
+        end
+      end
+
+      assert loaded.destroyed?
+      assert_nil TestModel.find_by(id: model.id)
+    end
+
+    def test_remove_persists_nil_to_database
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
+      end
+
+      assert_nil TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    # ============================================================
+    # 代入時の挙動
+    # ============================================================
+
+    def test_column_is_set_immediately_after_assignment
+      model = TestModel.new
+
+      assert_vcr_requests_made 'carrier_wave_test/save' do
+        attach_sample_image(model)
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+      assert_equal expect_identifier, model.resizing_picture.identifier
+      assert_equal expect_identifier, model.resizing_picture.file.public_id.to_s
+      assert_equal 'image/jpeg', model.resizing_picture.file.content_type
+      assert model.resizing_picture.present?
+    end
+
+    def test_save_after_assignment_does_not_upload_again
+      model = prepare_model TestModel
+
+      # 代入時に既にアップロード済みなので、save! で再度 POST は発行されない
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.save!
+      end
+
+      assert_equal expect_identifier, TestModel.find(model.id).read_attribute(:resizing_picture)
+    end
+
+    def test_assigning_nil_keeps_existing_image
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = nil
+        model.save!
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+      assert_equal "#{expect_url}/", model.resizing_picture_url
+    end
+
+    def test_assigning_blank_string_keeps_existing_image
+      model = prepare_model TestModel
+      model.save!
+
+      assert_vcr_no_requests 'carrier_wave_test/save' do
+        model.resizing_picture = ''
+        model.save!
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_assigning_plain_file_object_uploads_image
+      model = TestModel.new
+
+      assert_vcr_requests_made 'carrier_wave_test/save' do
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+      end
+
+      assert_equal expect_identifier, model.read_attribute(:resizing_picture)
+    end
+
+    def test_default_url_is_returned_after_remove
+      TestModelWithDefaultURL.delete_all
+      model = prepare_model TestModelWithDefaultURL
+      model.save!
+      refute_equal 'http://example.com/test.jpg', model.resizing_picture_url
+
+      assert_vcr_requests_made 'carrier_wave_test/remove_resizing_picture' do
+        model.remove_resizing_picture!
+        model.save!
+      end
+
+      assert_equal 'http://example.com/test.jpg', model.resizing_picture_url
+    end
+
+    # ============================================================
+    # 画像更新時の永続化
+    # ============================================================
+
+    def test_updated_image_is_persisted_and_old_image_deleted
+      # update_image カセット: POST(old) -> POST(new) -> DELETE(old)
+      model = nil
+      assert_vcr_requests_made 'carrier_wave_test/update_image' do
+        model = TestModel.new
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        model.save!
+
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+      end
+
+      loaded = TestModel.find(model.id)
+      assert_equal(
+        '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2',
+        loaded.read_attribute(:resizing_picture)
+      )
+      assert_equal(
+        'http://192.168.56.101:5000/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2/',
+        loaded.resizing_picture_url
+      )
+    end
+
+    def test_previous_changes_after_update_records_old_and_new_identifier
+      model = nil
+      assert_vcr_requests_made 'carrier_wave_test/update_image' do
+        model = TestModel.new
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        model.save!
+
+        model.resizing_picture = File.open('test/data/images/sample1.jpg', 'r')
+        ActiveRecord::Base.transaction do
+          model.save!
+        end
+      end
+
+      old_value, new_value = model.previous_changes['resizing_picture']
+      assert_match(/old-image-id/, old_value)
+      assert_match(/new-image-id/, new_value)
     end
   end
 end