resizing 1.2.1 → 1.3.1

data/lib/resizing/mock_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'securerandom'
+
 module Resizing
   class MockClient
     def post(_file_or_binary, _options = {})
@@ -10,33 +12,47 @@ module Resizing
     def put(name, _file_or_binary, _options)
       r = load_yaml('test/vcr/client/put.yml')
       result = JSON.parse(r['string'])
-      # replace name, public_id and version by name argument
+      # カセット内の値に依存せず、name と新しい version で id / public_id を組み立て直す
+      version = generate_version
       result['id'] = name
-      result['public_id'].gsub!(/AWEaewfAreaweFAFASfwe/, name)
-      result['public_id'].gsub!(/v6Ew3HmDAYfb3NMRdLxR45i_gXMbLlGyi/, "v#{Time.now.to_f}")
+      result['version'] = version
+      result['latest_version_id'] = version
+      result['public_id'] = build_public_id(result['public_id'], image_id: name, version: version)
       result
     end
 
     def delete(name)
       r = load_yaml('test/vcr/client/delete.yml')
       result = JSON.parse(r['string'])
-      # replace name and public_id by name argument
+      # カセット内の値に依存せず、name で id / public_id を組み立て直す
       result['id'] = name
-      result['public_id'].gsub!(/28c49144-c00d-4cb5-8619-98ce95977b9c/, name)
+      result['public_id'] = build_public_id(result['public_id'], image_id: name)
       result
     end
 
     def metadata(name, _options = {})
       r = load_yaml('test/vcr/client/metadata.yml')
       result = JSON.parse(r['string'])
-      # replace name and public_id by name argument
+      # カセット内の値に依存せず、name で id / public_id を組み立て直す
       result['id'] = name
-      result['public_id'].gsub!(/bfdaf2b3-7ec5-41f4-9caa-d53247dd9666/, name)
+      result['public_id'] = build_public_id(result['public_id'], image_id: name)
       result
     end
 
     private
 
+    # カセットの public_id を PublicId で分解し、image_id / version を差し替えて組み立て直す
+    def build_public_id(public_id, image_id:, version: nil)
+      parsed = Resizing::PublicId.new(public_id)
+      version ||= parsed.version
+      identifier = "/projects/#{parsed.project_id}/upload/images/#{image_id}"
+      version.nil? ? identifier : "#{identifier}/v#{version}"
+    end
+
+    def generate_version
+      SecureRandom.alphanumeric(32)
+    end
+
     def load_yaml(filename)
       path = "#{library_root}/#{filename}"
       YAML.load_file(path)['http_interactions'].first['response']['body']

data/lib/resizing/public_id.rb

@@ -7,8 +7,9 @@ module Resizing
       parsed
     end
 
+    # nil / 空文字 / 空白のみの文字列はいずれも「値なし」として扱う
     def empty?
-      @public_id.to_s.empty?
+      @public_id.to_s.strip.empty?
     end
 
     def image_id
@@ -39,7 +40,7 @@ module Resizing
     private
 
     def parsed
-      return nil if @public_id.nil?
+      return nil if empty?
 
       unless defined? @parsed
         @parsed = Resizing.separate_public_id(@public_id)

data/lib/resizing/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resizing
-  VERSION = '1.2.1'
+  VERSION = '1.3.1'
 end

data/lib/resizing.rb

@@ -14,7 +14,6 @@ module Resizing
   autoload :Configuration, 'resizing/configuration'
   autoload :CarrierWave, 'resizing/carrier_wave'
   autoload :PublicId, 'resizing/public_id'
-  autoload :Video, 'resizing/video'
   autoload :ActiveStorage, 'resizing/active_storage'
 
   class Error < StandardError; end

data/resizing.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Client and utilities for Resizing '
   spec.homepage      = 'https://github.com/jksy/resizing-gem'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1.0')
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0")
   end
   spec.require_paths = ['lib']
-  spec.add_runtime_dependency 'faraday', '~> 2.3'
-  spec.add_runtime_dependency 'faraday-multipart'
+  spec.add_runtime_dependency 'faraday', '>= 1.0', '< 3'
+  spec.add_runtime_dependency 'faraday-multipart', '>= 1.0'
   spec.add_development_dependency 'carrierwave', '~> 2.2.5'
   spec.add_development_dependency 'fog-aws'
   spec.add_development_dependency 'minitest', '~> 5.16'

data/test/resizing/carrier_wave/storage/file_test.rb

@@ -1,21 +1,18 @@
 # frozen_string_literal: true
 
 require 'test_helper'
+require 'tempfile'
 
 module Resizing
   module CarrierWave
     module Storage
       class FileTest < Minitest::Test
+        include VCRRequestAssertions
+        include FakeApiClientAssertions
+        include ResizingTestConfiguration
+
         def setup
-          @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
@@ -165,6 +162,455 @@ module Resizing
             file.delete
           end
         end
+
+        # ============================================================
+        # delete の詳細な挙動 (Resizing::Client を偽クライアントに差し替えて検証)
+        # ============================================================
+
+        IDENTIFIER = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/14ea7aac-a194-4330-931f-6b562aec413d/v_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e'
+        IMAGE_ID = '14ea7aac-a194-4330-931f-6b562aec413d'
+        OTHER_IDENTIFIER = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/new-image-id-2222-2222-222222222222/v2'
+        NOT_FOUND_RESPONSE = {
+          'error' => 'ActiveRecord::RecordNotFound',
+          'message' => "Upload::Image##{IMAGE_ID} not found(no record)"
+        }.freeze
+
+        def model_with_column(value)
+          model = TestModel.new
+          model.send(:write_attribute, :resizing_picture, value)
+          model
+        end
+
+        def test_delete_clears_column_when_deleted_image_is_current
+          model = model_with_column(IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            file.delete
+            assert_equal [IMAGE_ID], fake.deleted_ids
+          end
+
+          assert_nil model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_keeps_column_when_deleting_previous_image_after_update
+          # 画像更新時: カラムは新しい画像を指しているが、削除対象は古い画像なのでカラムは消さない
+          model = model_with_column(OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            file.delete
+            assert_equal [IMAGE_ID], fake.deleted_ids
+          end
+
+          assert_equal OTHER_IDENTIFIER, model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_treats_not_found_as_success_and_clears_column
+          model = model_with_column(IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          with_fake_api_client(NOT_FOUND_RESPONSE) do
+            assert_nil file.delete
+          end
+
+          assert_nil model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_treats_not_found_of_previous_image_without_clearing_column
+          model = model_with_column(OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          with_fake_api_client(NOT_FOUND_RESPONSE) { file.delete }
+
+          assert_equal OTHER_IDENTIFIER, model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_raises_api_error_when_response_id_does_not_match
+          model = model_with_column(IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          with_fake_api_client({ 'id' => 'someone-else' }) do
+            assert_raises(Resizing::APIError) { file.delete }
+          end
+
+          # 失敗時はカラムを変更しない
+          assert_equal IDENTIFIER, model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_uses_column_value_when_constructed_without_identifier
+          # remove! の経路では識別子なしで File が生成され、モデルのカラム値から削除対象を決める
+          model = model_with_column(IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            file.delete
+            assert_equal [IMAGE_ID], fake.deleted_ids
+          end
+
+          assert_nil model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_uses_previous_column_value_when_column_has_unsaved_change
+          # attribute_was: カラムが変更済み (保存前) の場合は変更前の値の画像を削除する
+          model = model_with_column(IDENTIFIER)
+          model.save!
+          model.send(:write_attribute, :resizing_picture, OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            file.delete
+            assert_equal [IMAGE_ID], fake.deleted_ids
+          end
+
+          # 削除したのは古い画像なので、新しい値はそのまま残る
+          assert_equal OTHER_IDENTIFIER, model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_does_not_write_column_of_destroyed_model
+          model = model_with_column(IDENTIFIER)
+          model.save!
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            ActiveRecord::Base.transaction do
+              model.destroy!
+            end
+            assert model.destroyed?
+            assert_equal [IMAGE_ID], fake.deleted_ids
+
+            # destroy 済み (frozen) のモデルに対して delete しても FrozenError にならない
+            file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+            file.delete
+          end
+        end
+
+        # ============================================================
+        # store の詳細な挙動 (Resizing.post を差し替えて送信内容を検証)
+        # ============================================================
+
+        POST_RESPONSE = {
+          'id' => IMAGE_ID,
+          'public_id' => IDENTIFIER,
+          'content_type' => 'image/jpeg'
+        }.freeze
+
+        def capture_post(response = POST_RESPONSE, &block)
+          captured = {}
+          responder = lambda do |content, options|
+            captured[:content] = content
+            captured[:options] = options
+            response.dup
+          end
+          Resizing.stub(:post, responder, &block)
+          captured
+        end
+
+        def new_storage_file(model = TestModel.new)
+          Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+        end
+
+        def test_store_posts_uploaded_file_with_its_content_type_and_original_filename
+          file = new_storage_file
+          uploaded_file = ActionDispatch::Http::UploadedFile.new(
+            filename: 'my photo.jpg',
+            type: 'image/jpeg',
+            tempfile: ::File.open('test/data/images/sample1.jpg', 'r')
+          )
+
+          captured = capture_post { file.store(uploaded_file) }
+
+          assert_equal 'image/jpeg', captured[:options][:content_type]
+          assert_equal 'my photo.jpg', captured[:options][:filename]
+          assert captured[:content].respond_to?(:read)
+          assert_equal 0, captured[:content].pos, 'IO should be rewound before upload'
+        end
+
+        def test_store_guesses_content_type_from_extension_for_plain_file
+          file = new_storage_file
+          source_file = ::File.open('test/data/images/sample1.jpg', 'r')
+          source_file.read(10) # 読み進めた状態でも巻き戻して送る
+
+          captured = capture_post { file.store(source_file) }
+
+          assert_equal 'image/jpeg', captured[:options][:content_type]
+          assert_equal 'sample1.jpg', captured[:options][:filename]
+          assert_equal 0, captured[:content].pos
+        end
+
+        # Issue #88: MIME::Types に登録のない拡張子でも例外にならず、
+        # application/octet-stream にフォールバックすること
+        def test_store_falls_back_to_octet_stream_for_unknown_extension
+          # 前提: この拡張子は MIME::Types に登録されていない
+          assert_empty MIME::Types.type_for('bookmark.url')
+
+          file = new_storage_file
+          tempfile = Tempfile.new(['bookmark', '.url'])
+          begin
+            tempfile.write("[InternetShortcut]\nURL=https://example.com/\n")
+            tempfile.rewind
+
+            captured = capture_post { file.store(tempfile) }
+
+            assert_equal 'application/octet-stream', captured[:options][:content_type]
+            assert_equal ::File.basename(tempfile.path), captured[:options][:filename]
+          ensure
+            tempfile.close!
+          end
+        end
+
+        def test_guess_content_type_falls_back_for_unknown_or_missing_path
+          file = new_storage_file
+
+          assert_equal 'image/jpeg', file.send(:guess_content_type, 'sample1.jpg')
+          assert_equal 'application/octet-stream', file.send(:guess_content_type, 'bookmark.url')
+          assert_equal 'application/octet-stream', file.send(:guess_content_type, 'no_extension')
+          assert_equal 'application/octet-stream', file.send(:guess_content_type, nil)
+        end
+
+        def test_store_sends_basename_only_as_filename
+          file = new_storage_file
+          uploaded_file = ActionDispatch::Http::UploadedFile.new(
+            filename: '/some/dir/photo.jpg',
+            type: 'image/jpeg',
+            tempfile: ::File.open('test/data/images/sample1.jpg', 'r')
+          )
+
+          captured = capture_post { file.store(uploaded_file) }
+
+          assert_equal 'photo.jpg', captured[:options][:filename]
+        end
+
+        def test_store_writes_public_id_into_model_column
+          model = TestModel.new
+          file = new_storage_file(model)
+
+          capture_post { file.store(::File.open('test/data/images/sample1.jpg', 'r')) }
+
+          assert_equal IDENTIFIER, model.read_attribute(:resizing_picture)
+          assert_equal IDENTIFIER, file.public_id.to_s
+          assert_equal IDENTIFIER, file.current_path
+          assert_equal IMAGE_ID, file.public_id.image_id
+        end
+
+        def test_store_uses_content_type_from_response
+          file = new_storage_file
+          response = POST_RESPONSE.merge('content_type' => 'image/webp')
+
+          capture_post(response) { file.store(::File.open('test/data/images/sample1.jpg', 'r')) }
+
+          assert_equal 'image/webp', file.content_type
+        end
+
+        def test_store_returns_true
+          file = new_storage_file
+          result = nil
+
+          capture_post { result = file.store(::File.open('test/data/images/sample1.jpg', 'r')) }
+
+          assert_equal true, result
+        end
+
+        def test_store_raises_for_storage_file_instance
+          model = TestModel.new
+          file = new_storage_file(model)
+          other = new_storage_file(model)
+
+          assert_raises(NotImplementedError) { file.store(other) }
+        end
+
+        # ============================================================
+        # current_path / name / public_id
+        # ============================================================
+
+        def test_current_path_falls_back_to_model_column
+          model = model_with_column(IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+
+          assert_equal IDENTIFIER, file.current_path
+          assert_equal IDENTIFIER, file.path
+        end
+
+        def test_current_path_prefers_identifier_over_model_column
+          model = model_with_column(OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          assert_equal IDENTIFIER, file.current_path
+        end
+
+        def test_name_reads_from_model_column_not_identifier
+          model = model_with_column(OTHER_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          assert_equal 'new-image-id-2222-2222-222222222222', file.name
+        end
+
+        def test_public_id_exposes_parsed_parts
+          model = TestModel.new
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          assert_equal IMAGE_ID, file.public_id.image_id
+          assert_equal 'e06e710d-f026-4dcf-b2c0-eab0de8bb83f', file.public_id.project_id
+          assert_equal '_8c5lEhDB5RT3PZp1Fn5PYGm9YVx_x0e', file.public_id.version
+        end
+
+        def test_retrieve_replaces_public_id
+          model = TestModel.new
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+          file.retrieve(OTHER_IDENTIFIER)
+
+          assert_equal OTHER_IDENTIFIER, file.public_id.to_s
+          assert_equal OTHER_IDENTIFIER, file.current_path
+        end
+
+        # ============================================================
+        # Issue #91: 未定義の `file` を参照していたメソッド群
+        # (size / content_type / read / exists? / attributes)
+        # ============================================================
+
+        # test/vcr/client/metadata.yml のカセットに対応する identifier
+        METADATA_IDENTIFIER = '/projects/e06e710d-f026-4dcf-b2c0-eab0de8bb83f/upload/images/87263920-2081-498e-a107-9625f4fde01b/vHg9VFvdI6HRzLFbV495VdwVmHIspLRCo'
+        METADATA_SIZE = 848_590
+
+        def storage_file_for(identifier)
+          Resizing::CarrierWave::Storage::File.new(TestModel.new.resizing_picture, identifier)
+        end
+
+        def test_size_content_type_exists_and_attributes_come_from_metadata_api
+          file = storage_file_for(METADATA_IDENTIFIER)
+
+          # メタデータは1回だけ取得され、以降はメモ化される
+          assert_vcr_requests_made 'client/metadata' do
+            assert_equal METADATA_SIZE, file.size
+            assert_equal 'image/jpeg', file.content_type
+            assert file.exists?
+            assert_equal 'sample1.jpg', file.attributes['filename']
+          end
+        end
+
+        def test_metadata_backed_methods_do_not_raise_name_error_without_public_id
+          file = new_storage_file
+
+          # public_id がないのでリクエストは発行されず、既定値を返す
+          assert_vcr_no_requests 'client/metadata' do
+            assert_equal 0, file.size
+            assert_nil file.content_type
+            refute file.exists?
+            assert_nil file.attributes
+          end
+        end
+
+        def test_metadata_backed_methods_do_not_raise_when_api_fails
+          file = storage_file_for(IDENTIFIER)
+
+          Resizing.stub(:metadata, ->(*) { raise Resizing::APIError, 'boom' }) do
+            assert_equal 0, file.size
+            assert_nil file.content_type
+            refute file.exists?
+            assert_nil file.attributes
+          end
+        end
+
+        def test_metadata_not_found_response_is_treated_as_missing
+          file = storage_file_for(IDENTIFIER)
+          not_found = { 'error' => 'ActiveRecord::RecordNotFound' }
+
+          Resizing.stub(:metadata, ->(*) { not_found }) do
+            refute file.exists?
+            assert_equal 0, file.size
+            assert_nil file.content_type
+          end
+        end
+
+        def test_content_type_prefers_locally_known_value_over_metadata_api
+          file = new_storage_file
+
+          # store 済みで content_type が分かっている場合はメタデータを取りに行かない
+          assert_vcr_no_requests 'client/metadata' do
+            capture_post { file.store(::File.open('test/data/images/sample1.jpg', 'r')) }
+
+            assert_equal 'image/jpeg', file.content_type
+          end
+        end
+
+        def test_metadata_falls_back_to_model_column_when_built_without_identifier
+          model = model_with_column(METADATA_IDENTIFIER)
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+
+          assert_vcr_requests_made 'client/metadata' do
+            assert_equal METADATA_SIZE, file.size
+          end
+        end
+
+        def test_retrieve_drops_cached_metadata_only_when_identifier_changes
+          file = storage_file_for(METADATA_IDENTIFIER)
+
+          assert_vcr_requests_made 'client/metadata' do
+            assert_equal METADATA_SIZE, file.size
+            # 同じ identifier での retrieve ではメタデータを再取得しない
+            file.retrieve(METADATA_IDENTIFIER)
+            assert_equal METADATA_SIZE, file.size
+          end
+
+          file.retrieve(IDENTIFIER)
+          Resizing.stub(:metadata, ->(*) { { 'size' => 1 } }) do
+            assert_equal 1, file.size
+          end
+        end
+
+        def test_read_raises_not_implemented_error_instead_of_name_error
+          file = storage_file_for(METADATA_IDENTIFIER)
+
+          error = assert_raises(NotImplementedError) { file.read }
+          assert_match(/Resizing/, error.message)
+        end
+
+        # Issue #91 の再現手順: DB から読み直したモデルの size が NameError にならないこと
+        # (CarrierWave の Uploader::Proxy#size は file.try(:size) を呼ぶ)
+        def test_uploader_proxy_size_and_content_type_for_model_loaded_from_db
+          model = model_with_column(METADATA_IDENTIFIER)
+          model.save!
+          loaded = TestModel.find(model.id)
+
+          assert_vcr_requests_made 'client/metadata' do
+            assert_equal METADATA_SIZE, loaded.resizing_picture.size
+            assert_equal 'image/jpeg', loaded.resizing_picture.content_type
+          end
+        end
+
+        # Issue #94: カラムに空文字が入っているレコードでも delete で例外にならない
+        def test_delete_does_nothing_when_column_is_empty_string
+          model = model_with_column('')
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture)
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            assert_nil file.delete
+            assert_empty fake.deleted_ids
+          end
+
+          assert_equal '', model.read_attribute(:resizing_picture)
+        end
+
+        def test_delete_does_nothing_when_identifier_is_empty_string
+          model = model_with_column('')
+          file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, '')
+
+          with_fake_api_client({ 'id' => IMAGE_ID }) do |fake|
+            assert_nil file.delete
+            assert_empty fake.deleted_ids
+          end
+        end
+
+        def test_delete_with_valid_public_id_clears_model_column
+          VCR.use_cassette 'carrier_wave_test/remove_resizing_picture', record: :none do
+            model = model_with_column(IDENTIFIER)
+            file = Resizing::CarrierWave::Storage::File.new(model.resizing_picture, IDENTIFIER)
+
+            file.delete
+
+            assert_nil model.read_attribute(:resizing_picture)
+          end
+        end
       end
     end
   end