resizing 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f29ef7826174501bc395b977648ea813a942ef8360e47611b9bbc8f87f153f37
-  data.tar.gz: daa52c23493aea0ac244f99827023a44c7cd0c9b000f2fcb60493bdf7d8161f8
+  metadata.gz: 97be4b8cf7324441cfa73563ea4f102ac47b947fc95adb9ccbad206fe802f785
+  data.tar.gz: ae8df42cb9197bdfc81874d83027e266ba523e3e0c90605ddafc93b310da4368
 SHA512:
-  metadata.gz: b00781a214e9c92780912bcaf0176927caf7f86ebac96fdabf6c178128862ac60540a2c953085c645fba9eb34a9b6808ec40e05327d400c2849f48397f4cf196
-  data.tar.gz: 59c63f87c52c42d807f8de5897d4ff3cfdebbca4ab9be807bfe31d29de8a4ff11313f22d8209d6a324abf25ce593a17510de4cebda5894b67b4f88cace308d75
+  metadata.gz: 56a57d325523e21d22a6e3c77c3907e6ec8860433e6524d8ee89da79381f29f56bb7b79af37805ab4be46c921b4e70c5cceb99039de947231c50f7838c4fa544
+  data.tar.gz: 18c995f91897d11813477ea16298c2e3101c352f611ecf84e23fb57954e86b6d2c44d28a48515f3df42548b27b0bbebb2b413af85797ce246e9ef22e52d71639

data/.github/workflows/test.yml

@@ -7,18 +7,33 @@ on:
       - master
 
 permissions:
-  id-token: write # This is required for requesting the JWT
+  id-token: write # This is required for codecov/codecov-action
   contents: read  # This is required for actions/checkout
 
 jobs:
   test:
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.7.6', '3.1', '3.2','3.3']
+        ruby: ['3.1', '3.2','3.3', '3.4']
+        rails: ['6.1', '7.0', '7.1', '7.2']
+        exclude:
+          # Rails 7.2 requires Ruby 3.1+
+          - ruby: '3.1'
+            rails: '7.2'
+          # Rails 7.1 requires Ruby 3.1+
+          - ruby: '3.1'
+            rails: '7.1'
+          # Rails 6.1 requires Ruby under 3.3
+          - ruby: '3.4'
+            rails: '6.1'
 
     runs-on: ubuntu-22.04
 
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+
     steps:
       - uses: actions/checkout@v4
 

data/.gitignore

@@ -6,3 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+vendor/
+Gemfile.lock
+tags
+sample1.jpg
+.ruby-version
+uploads/

data/Gemfile

@@ -5,8 +5,12 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in resizing.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+# Allow testing against different Rails versions
+rails_version = ENV['RAILS_VERSION'] || '7.0'
+gem 'rails', "~> #{rails_version}"
+
+gem 'byebug'
 gem 'github_changelog_generator'
 gem 'mysql2'
-gem 'byebug'
 gem 'pry-byebug'
+gem 'rake', '~> 13.0'

data/README.md

@@ -1,8 +1,14 @@
 # Resizing
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/resizing`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://img.shields.io/gem/v/resizing.svg)](https://rubygems.org/gems/resizing)
+[![test](https://github.com/jksy/resizing-gem/actions/workflows/test.yml/badge.svg)](https://github.com/jksy/resizing-gem/actions/workflows/test.yml)
+[![codecov](https://codecov.io/gh/jksy/resizing-gem/graph/badge.svg)](https://codecov.io/gh/jksy/resizing-gem)
 
-TODO: Delete this and the text above, and describe your gem
+Client and utilities for [Resizing](https://www.resizing.net/) - an image hosting and transformation service.
+
+## Requirements
+
+- Ruby 3.1.0 or later
 
 ## Installation
 
@@ -20,37 +26,59 @@ Or install it yourself as:
 
     $ gem install resizing
 
+## Configuration
+
+```ruby
+Resizing.configure = {
+  image_host: 'https://img.resizing.net',
+  video_host: 'https://video.resizing.net',
+  project_id: 'your-project-id',
+  secret_token: 'your-secret-token'
+}
+```
+
 ## Usage
 
+### Basic Client Usage
+
+```ruby
+# Initialize client
+client = Resizing::Client.new
+
+# Upload image to resizing
+file = File.open('sample.jpg', 'r')
+response = client.post(file)
+# => {
+#      "id"=>"a4ed2bf0-a4cf-44fa-9c82-b53e581cb469",
+#      "project_id"=>"098a2a0d-0000-0000-0000-000000000000",
+#      "content_type"=>"image/jpeg",
+#      "latest_version_id"=>"LJY5bxBF7Ryxfr5kC1F.63W8bzp3pcUm",
+#      "latest_etag"=>"\"190143614e6c342637584f46f18f8c58\"",
+#      "created_at"=>"2020-05-15T15:33:10.711Z",
+#      "updated_at"=>"2020-05-15T15:33:10.711Z",
+#      "url"=>"/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469"
+#    }
+
+# Generate transformation URL
+image_id = response['id']
+transformation_url = Resizing.url_from_image_id(image_id, nil, ['w_200', 'h_300'])
+# => "https://img.resizing.net/projects/.../upload/images/.../w_200,h_300"
 ```
-  # initialize client
-  options = {
-    project_id: '098a2a0d-0000-0000-0000-000000000000',
-    secret_token: '4g1cshg......rbs6'
-  }
-  client = Resizing::Client.new(options)
-
-  # upload image to resizing
-  file = File.open('sample.jpg', 'r')
-  response = client.post(file)
-  => {
-       "id"=>"a4ed2bf0-a4cf-44fa-9c82-b53e581cb469",
-       "project_id"=>"098a2a0d-0000-0000-0000-000000000000",
-       "content_type"=>"image/jpeg",
-       "latest_version_id"=>"LJY5bxBF7Ryxfr5kC1F.63W8bzp3pcUm",
-       "latest_etag"=>"\"190143614e6c342637584f46f18f8c58\"",
-       "created_at"=>"2020-05-15T15:33:10.711Z",
-       "updated_at"=>"2020-05-15T15:33:10.711Z",
-       "url"=>"/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469"
-     }
-
-  name = response['url']
-  # get transformation url
-  name = response['url']
-  transform = {width: 200, height: 300}
-
-  transformation_url = Resizing.url(name, transform)
-  => "https://www.resizing.net/projects/098a2a0d-0000-0000-0000-000000000000/upload/images/a4ed2bf0-a4cf-44fa-9c82-b53e581cb469/width_200,height_300"
+
+### CarrierWave Integration
+
+```ruby
+class ImageUploader < CarrierWave::Uploader::Base
+  include Resizing::CarrierWave
+
+  version :list_smallest do
+    process resize_to_fill: [200, 200]
+  end
+end
+
+class User
+  mount_uploader :image, ImageUploader
+end
 ```
 
 ## Development
@@ -61,8 +89,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jksy/resizing.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/jksy/resizing-gem.
 
 ## License
 

data/lib/resizing/active_storage/service/resizing_service.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
+require 'active_storage/service'
+
 module Resizing
   module ActiveStorage
     module Service
       # ref.
       # https://github.com/rails/rails/blob/master/activestorage/lib/active_storage/service/s3_service.rb
       #
-      # rubocop:disable Lint/UnusedMethodArgument,Metrics/ParameterLists
+      # rubocop:disable Metrics/ParameterLists
       class ResizingService < ::ActiveStorage::Service
         # def initialize(bucket:, upload: {}, public: false, **options)
+        # rubocop:disable Lint/MissingSuper
         def initialize; end
+        # rubocop:enable Lint/MissingSuper
 
         def upload(_key, _io, checksum: nil, filename: nil, content_type: nil, disposition: nil, **)
           raise NotImplementedError, 'upload is not implemented'
@@ -51,7 +55,7 @@ module Resizing
           raise NotImplementedError, 'public_url is not implemented'
         end
       end
-      # rubocop:enable Lint/UnusedMethodArgument,Metrics/ParameterLists
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/resizing/active_storage/service.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Resizing
+  module ActiveStorage
+    module Service
+      autoload :ResizingService, 'resizing/active_storage/service/resizing_service'
+    end
+  end
+end

data/lib/resizing/active_storage.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Resizing
+  module ActiveStorage
+    autoload :Service, 'resizing/active_storage/service'
+  end
+end

data/lib/resizing/carrier_wave/storage/file.rb

@@ -3,6 +3,7 @@
 module Resizing
   module CarrierWave
     module Storage
+      # rubocop:disable Metrics/ClassLength
       class File
         include ::CarrierWave::Utilities::Uri
 
@@ -28,23 +29,42 @@ module Resizing
           @content_type || file.try(:content_type)
         end
 
+        # rubocop:disable Metrics/AbcSize
         def delete
-          @public_id = Resizing::PublicId.new(model.send :read_attribute, serialization_column)
-          return if @public_id.empty? # do nothing
+          # Use the identifier from constructor if available, otherwise try to get from model
+          if @public_id.present?
+            # Already set from constructor or retrieve
+          elsif model.respond_to?(:attribute_was)
+            # Try to get the value before changes (for remove! scenario)
+            column_value = model.attribute_was(serialization_column) || model.send(:read_attribute,
+                                                                                   serialization_column)
+            @public_id = Resizing::PublicId.new(column_value)
+          else
+            column_value = model.send(:read_attribute, serialization_column)
+            @public_id = Resizing::PublicId.new(column_value)
+          end
+
+          return if @public_id.empty?
 
           resp = client.delete(@public_id.image_id)
+
+          # NOTE: 削除時のカラムクリアは以下の理由で必要:
+          # - 画像更新時: 古い画像IDと新しい画像IDが異なるため、古い画像削除時に新しいIDを消さないようにする
+          # - 明示的なremove!時: カラムをnilにする必要がある
+          # - clear_column_if_current_imageは削除される画像IDと現在のカラム値を比較して判断
           if resp['error'] == 'ActiveRecord::RecordNotFound' # 404 not found
-            model.send :write_attribute, serialization_column, nil unless model.destroyed?
+            clear_column_if_current_image
             return
           end
 
           if @public_id.image_id == resp['id']
-            model.send :write_attribute, serialization_column, nil unless model.destroyed?
+            clear_column_if_current_image
             return
           end
 
           raise APIError, "raise someone error:#{resp.inspect}"
         end
+        # rubocop:enable Metrics/AbcSize
 
         def extension
           raise NotImplementedError, 'this method is do not used. maybe'
@@ -79,34 +99,38 @@ module Resizing
         end
 
         def current_path
+          # Return the path from @public_id if set (for retrieve scenarios),
+          # otherwise fall back to reading from model
+          return @public_id.to_s if @public_id.present?
+
           @current_path = model.send :read_attribute, serialization_column
         end
         alias path current_path
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/MethodLength, Metrics/PerceivedComplexity
         def store(new_file)
           if new_file.is_a?(self.class)
             # new_file.copy_to(path)
             raise NotImplementedError, 'new file is required duplicating'
           end
 
-          if new_file.respond_to? :content_type
-            @content_type ||= new_file.content_type
-          else
-            # guess content-type from extension
-            @content_type ||= MIME::Types.type_for(new_file.path).first.content_type
-          end
+          @content_type ||= if new_file.respond_to? :content_type
+                              new_file.content_type
+                            else
+                              # guess content-type from extension
+                              MIME::Types.type_for(new_file.path).first.content_type
+                            end
 
           original_filename = new_file.try(:original_filename) || new_file.try(:filename) || new_file.try(:path)
-          if original_filename.present?
-            original_filename = ::File.basename(original_filename)
-          end
+          original_filename = ::File.basename(original_filename) if original_filename.present?
 
           content = if new_file.respond_to?(:to_io)
                       new_file.to_io.tap(&:rewind)
                     elsif new_file.respond_to?(:read) && new_file.respond_to?(:rewind)
-                      new_file.read.tap do
-                        new_file.rewind
-                      end
+                      # Pass the IO object itself, not the read result
+                      new_file.rewind
+                      new_file
                     else
                       new_file
                     end
@@ -115,19 +139,24 @@ module Resizing
           @public_id = Resizing::PublicId.new(@response['public_id'])
           @content_type = @response['content_type']
 
-          # force update column
-          # model_class
-          #   .where(primary_key_name => model.send(primary_key_name))
-          #   .update_all(serialization_column=>@public_id)
-
+          # NOTE: 理想的にはStorage::File内でモデルのカラムをいじらず、CarrierWaveに任せるべきだが、
+          # 現在の実装では以下の理由で必要:
+          # - CarrierWaveは write_uploader(column, mounter.identifiers.first) でカラムを更新
+          # - mounter.identifiers -> uploaders.map(&:identifier) -> storage.identifier -> uploader.filename
+          # - resizing-gemの filenameメソッドは read_column を返す（既存のカラム値）
+          # - そのため、CarrierWaveに任せると旧い値が書き戻されてしまう
+          # TODO: これを修正するには、Remote#identifierをオーバーライドして@public_id.to_sを返すか、
+          #       uploader.filenameの実装を変更する必要がある
           # save new value to model class
           model.send :write_attribute, serialization_column, @public_id.to_s
 
           true
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/MethodLength, Metrics/PerceivedComplexity
 
-        def name(options = {})
-          @public_id = PublicId.new(model.send :read_attribute, serialization_column)
+        def name(_options = {})
+          @public_id = PublicId.new(model.send(:read_attribute, serialization_column))
           CGI.unescape(@public_id.filename)
         end
 
@@ -138,6 +167,7 @@ module Resizing
         def retrieve(identifier)
           @public_id = Resizing::PublicId.new(identifier)
         end
+
         private
 
         attr_reader :uploader
@@ -158,6 +188,20 @@ module Resizing
           @serialization_column ||= model.send(:_mounter, uploader.mounted_as).send(:serialization_column)
         end
 
+        # Only clear the column if the deleted image is the current one
+        # (not when deleting an old image during update)
+        def clear_column_if_current_image
+          return if model.destroyed?
+
+          current_value = model.send(:read_attribute, serialization_column)
+          current_public_id = Resizing::PublicId.new(current_value)
+
+          # Only clear if the deleted image is the same as the current one
+          return unless current_public_id.image_id == @public_id.image_id
+
+          model.send :write_attribute, serialization_column, nil
+        end
+
         ##
         # client of Resizing
         def client
@@ -195,7 +239,6 @@ module Resizing
           parameters.count == 2 && parameters[1].include?(:options)
         end
 
-
         # def retrieve_from_cache!(identifier)
         #   raise NotImplementedError,
         #     "Need to implement #retrieve_from_cache! if you want to use #{self.class.name} as a cache storage."
@@ -211,6 +254,7 @@ module Resizing
         #     "Need to implement #clean_cache! if you want to use #{self.class.name} as a cache storage."
         # end
       end
+      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/resizing/carrier_wave/storage/remote.rb

@@ -18,9 +18,13 @@ module Resizing
           f
         end
 
-        # def retrieve!(identifier)
-        #   super
-        # end
+        def retrieve!(identifier)
+          return nil if identifier.blank?
+
+          f = Resizing::CarrierWave::Storage::File.new(uploader, identifier)
+          f.retrieve(identifier)
+          f
+        end
 
         def cache!(new_file)
           f = Resizing::CarrierWave::Storage::File.new(uploader)

data/lib/resizing/carrier_wave.rb

@@ -4,6 +4,7 @@ require 'resizing/carrier_wave/storage/file'
 require 'resizing/carrier_wave/storage/remote'
 
 module Resizing
+  # rubocop:disable Metrics/ModuleLength
   module CarrierWave
     class Railtie < ::Rails::Railtie
       # Railtie skelton codes
@@ -28,15 +29,25 @@ module Resizing
     def initialize(*args)
       @requested_format = nil
       @default_format = nil
+      @retrieved_identifier = nil
       super
     end
 
+    # Override to store the identifier and set up @file for later use
+    def retrieve_from_store!(identifier)
+      @retrieved_identifier = identifier
+      super
+      # Ensure @file is set up so that remove! can call @file.delete
+      file
+    end
+
     def file
-      return if identifier.nil?
-      return @file unless defined? @file
+      file_identifier = @retrieved_identifier || identifier || read_column
+
+      return nil if file_identifier.blank?
 
       @file ||= Resizing::CarrierWave::Storage::File.new(self)
-      @file.retrieve(identifier)
+      @file.retrieve(file_identifier)
       @file
     end
 
@@ -45,7 +56,8 @@ module Resizing
 
       transforms = args.map do |version|
         version = version.intern
-        raise "No version is found: #{version}, #{versions.keys} are exists." unless versions.has_key? version
+        raise "No version is found: #{version}, #{versions.keys} are exists." unless versions.key? version
+
         versions[version].transform_string
       end.compact
 
@@ -108,11 +120,6 @@ module Resizing
       read_column
     end
 
-    def store!
-      # DO NOTHING
-      super
-    end
-
     def serialization_column
       model.send(:_mounter, mounted_as).send(:serialization_column)
     end
@@ -150,7 +157,7 @@ module Resizing
 
     private
 
-    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
     def transform_string_from(processor)
       action = processor.first
       value = processor.second
@@ -173,6 +180,7 @@ module Resizing
         "#{key}_#{value}"
       end.compact.join(',')
     end
-    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/resizing/client.rb

@@ -24,6 +24,7 @@ module Resizing
   #   }
   #
   #++
+  # rubocop:disable Metrics/ClassLength
   class Client
     include Resizing::Constants
     include Resizing::Configurable
@@ -53,8 +54,7 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
     def put(image_id, filename_or_io, options)
@@ -73,8 +73,7 @@ module Resizing
         end
       end
 
-      result = handle_create_response(response)
-      result
+      handle_create_response(response)
     end
 
     def delete(image_id)
@@ -86,8 +85,7 @@ module Resizing
         end
       end
 
-      result = handle_delete_response(response)
-      result
+      handle_delete_response(response)
     end
 
     def metadata(image_id, options = {})
@@ -99,8 +97,7 @@ module Resizing
         end
       end
 
-      result = handle_metadata_response(response, options)
-      result
+      handle_metadata_response(response, options)
     end
 
     private
@@ -114,8 +111,7 @@ module Resizing
     end
 
     def gather_filename(filename_or_io, options)
-      filename = options[:filename]
-      filename ||= filename_or_io.respond_to?(:path) ? File.basename(filename_or_io.path) : nil
+      options[:filename] || (filename_or_io.respond_to?(:path) ? File.basename(filename_or_io.path) : nil)
     end
 
     def build_put_url(image_id)
@@ -137,17 +133,17 @@ module Resizing
     def ensure_filename_or_io(filename_or_io)
       return if filename_or_io.is_a?(File)
 
-      if filename_or_io.is_a?(String)
-        if File.exist?(filename_or_io)
-          return
-        end
-      end
+      # Accept IO-like objects (StringIO, Tempfile, etc.)
+      return if filename_or_io.respond_to?(:read) && filename_or_io.respond_to?(:rewind)
 
-      raise ArgumentError, "filename_or_io must be a File object or a path to a file (#{filename_or_io.class})"
+      return if filename_or_io.is_a?(String) && File.exist?(filename_or_io)
+
+      raise ArgumentError,
+            "filename_or_io must be a File object, an IO-like object, or a path to a file (#{filename_or_io.class})"
     end
 
     def handle_create_response(response)
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
       when HTTP_STATUS_OK, HTTP_STATUS_CREATED
@@ -158,7 +154,7 @@ module Resizing
     end
 
     def handle_delete_response(response)
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
       when HTTP_STATUS_OK, HTTP_STATUS_NOT_FOUND
@@ -171,24 +167,30 @@ module Resizing
     def handle_metadata_response(response, options = {})
       when_not_found = options[:when_not_found] || nil
 
-      raise APIError, "No response is returned" if response.nil?
+      raise APIError, 'No response is returned' if response.nil?
 
       case response.status
-      when HTTP_STATUS_OK, HTTP_STATUS_NOT_FOUND
+      when HTTP_STATUS_OK
         JSON.parse(response.body)
       when HTTP_STATUS_NOT_FOUND
         raise decode_error_from(response) if when_not_found == :raise
-        nil
+
+        JSON.parse(response.body)
       else
         raise decode_error_from(response)
       end
     end
 
-    def decode_error_from response
-      result = JSON.parse(response.body) rescue {}
+    def decode_error_from(response)
+      result = begin
+        JSON.parse(response.body)
+      rescue StandardError
+        {}
+      end
       err = APIError.new(result['message'] || "invalid http status code #{response.status}")
       err.decoded_body = result
       err
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/resizing/configurable.rb

@@ -2,7 +2,7 @@
 
 module Resizing
   module Configurable
-    def self.included mod
+    def self.included(mod)
       mod.send(:attr_reader, :config)
     end