jr-paperclip 8.0.0.beta.1 → 8.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e0a02cb6a9a3a1b126b744de6afe4654e9db7bf841bb710ac29b3cb702f5a2'
-  data.tar.gz: 5c3c603853869aa41d56026de0d71788f87f7b98ec4d8382adc811e23bc9eb42
+  metadata.gz: 3471aff8a216591311cb34c95962b5d564db389b7f5807016e441a784db30de7
+  data.tar.gz: a1ea72929da0b406cabffda02181afee1c9689690dd0181ec07b062335af2832
 SHA512:
-  metadata.gz: 9b71eb967b7cb2b0980e665c4886bbb5754bac409677b0af4e13578101dde22d710ab2bc11e31287dac3e99520f53f9e9b44fe79f5285f5fd5aa2cfe070edf43
-  data.tar.gz: ab955ec831d70c792bcaccbb41b5e2b6754fe0badddc1a52735d5a974f0982e3cdda316e5db9a274da73132482515ebf5b74775780d8e179e6d2493154370610
+  metadata.gz: 7849243e644ea536368cae8a1de481b8e476def749691e6beede5d767ddb3d92fff653e4fd1c2afd14eb4b843b6fef147f5c94cb3761d6d6df2bf76f1ea1f83f
+  data.tar.gz: 150d39995dc7e1102e19371c6a3bd8e26122b2942832c394a88bbe6f3105bc1e573e58055318ce83b0b0dd4f3672498fd5199a9d48d08fbe8cc93862e353156c

data/.github/workflows/tests.yml

@@ -46,7 +46,7 @@ jobs:
       - name: Install dependencies
         run: |
           sudo apt-get update
-          sudo apt-get install -y ghostscript imagemagick libvips
+          sudo apt-get install -y ghostscript imagemagick libvips libvips-tools
           sudo rm -f /etc/ImageMagick-6/policy.xml
 
       - name: Run tests

data/NEWS

@@ -1,4 +1,4 @@
-8.0.0.beta.1 (2026-01-09)
+8.0.0.beta.2 (2026-01-12)
 
 * Feature: Add libvips backend alongside ImageMagick via the image_processing gem
 * Feature: Per-attachment and per-style backend selection (`:backend` option)

data/README.md

@@ -734,12 +734,14 @@ has_attached_file :image, styles: { regular: ['800x800>', :png]},
     convert_options: { regular: "-posterize 3"}
 ```
 
-Since Paperclip now delegates to the `image_processing` gem, you should refer to its documentation for available methods/operations for your chosen backend:
+Paperclip delegates to the `image_processing` gem, but **whitelists supported options** for security. For ImageMagick, most standard options are supported. For libvips, a curated set of common options is available (see table below) and `Paperclip::Thumbnail` class. Unsupported options are logged as warnings and skipped.
+
+For full backend capabilities, refer to the image_processing documentation:
 
 *   **ImageMagick:** [ImageProcessing::MiniMagick documentation](https://github.com/janko/image_processing/blob/master/doc/minimagick.md)
 *   **libvips:** [ImageProcessing::Vips documentation](https://github.com/janko/image_processing/blob/master/doc/vips.md)
 
-Common options like `-strip`, `-quality`, `-rotate`, `-blur` are supported on both backends, but backend-specific options (like `-density` for ImageMagick) might not be available or behave differently on libvips.
+Common options like `-strip`, `-quality`, `-rotate`, `-blur` are supported on both backends. Backend-specific options (like `-density` for ImageMagick) may not be available on libvips.
 
 ### Cross-Platform Convert Options
 
@@ -757,6 +759,7 @@ Many common `convert_options` now work with **both** ImageMagick and libvips bac
 | `-colorspace X` | Color space (Gray, sRGB, CMYK) | `convert_options: "-colorspace Gray"` |
 | `-negate` | Invert colors | `convert_options: "-negate"` |
 | `-flatten` | Flatten transparency | `convert_options: "-flatten"` |
+| `-gamma N` | Adjust image gamma | `convert_options: "-gamma 1.5"` |
 | `-auto-orient` | Auto-rotate via EXIF | `convert_options: "-auto-orient"` |
 | `-interlace X` | Progressive output | `convert_options: "-interlace Plane"` |
 

data/VIPS_MIGRATION_GUIDE.md

@@ -23,7 +23,7 @@ sudo apt install libvips
 Ensure you are using the latest version of the gem:
 
 ```ruby
-gem "jr-paperclip", "~> 8.0.0.beta"
+gem "jr-paperclip", "~> 8.0.0.beta.2"
 ```
 
 ## Step 2: Gradual Migration (Per-Attachment)
@@ -73,7 +73,7 @@ has_attached_file :avatar,
 
 ### ImageMagick-Only Options
 
-The following options only work with ImageMagick. When used with the vips backend, they will be skipped and a warning will be logged:
+For example the following options only work with ImageMagick. When used with the vips backend, they will be skipped and a warning will be logged:
 
 `-density`, `-depth`, `-gravity`, `-crop`, `-extent`, `-alpha`, `-background`, `-type`, `-posterize`, `-dither`, `-colors`, `-channel`, `-transpose`, `-transverse`, `-normalize`, `-equalize`, `-trim`, `-monochrome`
 
@@ -89,6 +89,9 @@ However, if you want to migrate a custom processor to libvips, you can now use t
 module Paperclip
   class MyVipsProcessor < Processor
     def make
+      basename = File.basename(file.path, File.extname(file.path))
+      dst = Paperclip::TempfileFactory.new.generate("#{basename}.png")
+
       # Use the new vips helper instead of convert
       vips("thumbnail :src :dst 100",
            src: File.expand_path(file.path),

data/lib/paperclip/thumbnail.rb

@@ -476,30 +476,51 @@ module Paperclip
         pipeline.custom(&:flipver)
       when "flop"
         pipeline.custom(&:fliphor)
-      when "blur"
+      when "blur", "gaussian_blur", "gaussblur"
         # Vips uses gaussblur with sigma parameter
         # ImageMagick blur is "radiusxsigma", extract sigma
         sigma = extract_blur_sigma(value)
-        sigma ? pipeline.custom { |img| img.gaussblur(sigma) } : pipeline
-      when "gaussian_blur"
-        sigma = extract_blur_sigma(value)
-        sigma ? pipeline.custom { |img| img.gaussblur(sigma) } : pipeline
+        sigma ? pipeline.gaussblur(sigma) : pipeline
       when "sharpen"
         # Vips sharpen has different parameters than ImageMagick
         # Use sensible defaults for unsharp masking
         pipeline.custom(&:sharpen)
-      when "colorspace"
+      when "colorspace", "colourspace"
         # Vips uses British spelling "colourspace"
-        value ? pipeline.custom { |img| img.colourspace(vips_colorspace(value)) } : pipeline
+        value ? pipeline.colourspace(vips_colorspace(value)) : pipeline
+      when "gamma"
+        # Vips gamma uses keyword argument
+        value ? pipeline.custom { |img| img.gamma(exponent: value.to_f) } : pipeline
       when "flatten"
         pipeline.custom { |img| img.flatten(background: [255, 255, 255]) }
       when "negate", "invert"
         pipeline.custom(&:invert)
-      when "auto_orient"
+      when "auto_orient", "autorot"
         pipeline.autorot
       when "interlace"
         # Vips handles interlacing via saver options
         pipeline.saver(interlace: true)
+      # Vips-native options (direct vips method names)
+      when "median"
+        value ? pipeline.median(value.to_i) : pipeline
+      when "rot90"
+        pipeline.rot90
+      when "rot180"
+        pipeline.rot180
+      when "rot270"
+        pipeline.rot270
+      when "similarity"
+        # similarity for arbitrary rotation/scale
+        value ? pipeline.custom { |img| img.similarity(angle: value.to_f) } : pipeline
+      # Edge detection filters (no arguments)
+      when "canny"
+        pipeline.canny
+      when "sobel"
+        pipeline.sobel
+      when "prewitt"
+        pipeline.custom(&:prewitt)
+      when "scharr"
+        pipeline.custom(&:scharr)
       else
         # Unknown option - log warning for vips
         Paperclip.log("Warning: -#{opt_name} is not supported with vips backend, skipping")

data/lib/paperclip/version.rb

@@ -1,3 +1,3 @@
 module Paperclip
-  VERSION = "8.0.0.beta.1" unless defined?(Paperclip::VERSION)
+  VERSION = "8.0.0.beta.2" unless defined?(Paperclip::VERSION)
 end

data/spec/paperclip/migration_guide_example_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+module Paperclip
+  class MyVipsProcessor < Processor
+    def make
+      basename = File.basename(file.path, File.extname(file.path))
+      dst = Paperclip::TempfileFactory.new.generate("#{basename}.png")
+
+      # Use the new vips helper instead of convert
+      vips("thumbnail :src :dst 100",
+           src: File.expand_path(file.path),
+           dst: File.expand_path(dst.path))
+      dst
+    end
+  end
+end
+
+describe Paperclip::MyVipsProcessor do
+  let(:file) { File.open(fixture_file("50x50.png")) }
+  let(:options) { {} }
+  let(:attachment) { double }
+  let(:processor) { Paperclip::MyVipsProcessor.new(file, options, attachment) }
+
+  subject { processor.make }
+
+  it "processes the image using vips helper" do
+    expect(subject).to respond_to(:path)
+    expect(File.exist?(subject.path)).to be true
+
+    # Check width using vipsheader
+    require "shellwords"
+    dimensions = `identify -format "%wx%h" "#{Shellwords.escape(subject.path)}"`.strip
+    expect(dimensions).to eq("100x100")
+  end
+
+  it "calls the vips command" do
+    expect(Paperclip).to receive(:run).with(
+      "vips",
+      "thumbnail :src :dst 100",
+      hash_including(:src, :dst),
+    )
+    processor.make
+  end
+end

data/spec/paperclip/thumbnail_custom_options_spec.rb

@@ -11,8 +11,8 @@ describe Paperclip::Thumbnail do
 
     it "correctly applies options starting with +" do
       # The user's specific options - with Shellwords, quoted values are parsed correctly
-      convert_options = '-coalesce +profile "!icc,*" +set date:modify +set date:create +set date:timestamp'
-
+      convert_options = '-coalesce -quality 90 +profile "!icc,*" +set date:modify ' \
+                        "+set date:create +set date:timestamp -define jpeg:dct-method=float"
       thumb = Paperclip::Thumbnail.new(@file, {
                                          geometry: "100x100",
                                          convert_options: convert_options,
@@ -20,15 +20,17 @@ describe Paperclip::Thumbnail do
                                        }, @attachment)
 
       # Spy on the pipeline to verify the correct methods/arguments are called on it.
-      allow(thumb).to receive(:apply_single_option).and_call_original
+      allow(thumb).to receive(:apply_imagemagick_option).and_call_original
       expect { thumb.make }.not_to raise_error
 
       # With Shellwords parsing, the outer quotes are stripped from "!icc,*" -> !icc,*
-      expect(thumb).to have_received(:apply_single_option).with(anything, "coalesce", nil, "-")
-      expect(thumb).to have_received(:apply_single_option).with(anything, "profile", "!icc,*", "+")
-      expect(thumb).to have_received(:apply_single_option).with(anything, "set", "date:modify", "+")
-      expect(thumb).to have_received(:apply_single_option).with(anything, "set", "date:create", "+")
-      expect(thumb).to have_received(:apply_single_option).with(anything, "set", "date:timestamp", "+")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "coalesce", nil, "-")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "quality", "90", "-")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "profile", "!icc,*", "+")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "set", "date:modify", "+")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "set", "date:create", "+")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "set", "date:timestamp", "+")
+      expect(thumb).to have_received(:apply_imagemagick_option).with(anything, "define", "jpeg:dct-method=float", "-")
     end
   end
 
@@ -170,4 +172,54 @@ describe Paperclip::Thumbnail do
       expect(output).to include("second_prop: Second Value")
     end
   end
+
+  context "with vips-specific convert_options" do
+    before do
+      begin
+        require "vips"
+      rescue LoadError
+        skip "libvips not installed"
+      end
+      @file = File.new(fixture_file("5k.png"), "rb")
+      @attachment = double("Attachment", options: {})
+    end
+
+    after { @file.close if @file && !@file.closed? }
+
+    it "processes vips-native options correctly" do
+      convert_options = "-rot90"
+      file = File.new(fixture_file("rotated.jpg"), "rb")
+
+      thumb = Paperclip::Thumbnail.new(file, {
+                                         geometry: "100x100",
+                                         convert_options: convert_options,
+                                         backend: :vips,
+                                       }, @attachment)
+
+      # Processes without error
+      result = nil
+      expect { result = thumb.make }.not_to raise_error
+
+      require "shellwords"
+      dimensions = `identify -format "%wx%h" "#{Shellwords.escape(result.path)}"`.strip
+      width, height = dimensions.split("x").map(&:to_i)
+      # After 90 degree rotate, width should be greater than height
+      expect(width).to be > height
+      file.close
+    end
+
+    it "logs warning for unsupported vips options" do
+      convert_options = "-coalesce -unknown_vips_option foo"
+
+      thumb = Paperclip::Thumbnail.new(@file, {
+                                         geometry: "100x100",
+                                         convert_options: convert_options,
+                                         backend: :vips,
+                                       }, @attachment)
+
+      expect(Paperclip).to receive(:log).with(/Warning.*coalesce.*not supported/)
+      expect(Paperclip).to receive(:log).with(/Warning.*unknown_vips_option.*not supported/)
+      expect { thumb.make }.not_to raise_error
+    end
+  end
 end

data/spec/paperclip/thumbnail_spec.rb

@@ -71,20 +71,20 @@ describe Paperclip::Thumbnail do
 
         # Process with vips backend
         vips_processor = described_class.new(@file, {
-          geometry: "50x50#",
-          backend: :vips,
-          style: :vips_thumb
-        }, attachment)
+                                               geometry: "50x50#",
+                                               backend: :vips,
+                                               style: :vips_thumb,
+                                             }, attachment)
         vips_result = vips_processor.make
 
         @file.rewind
 
         # Process with image_magick backend
         magick_processor = described_class.new(@file, {
-          geometry: "50x50#",
-          backend: :image_magick,
-          style: :magick_thumb
-        }, attachment)
+                                                 geometry: "50x50#",
+                                                 backend: :image_magick,
+                                                 style: :magick_thumb,
+                                               }, attachment)
         magick_result = magick_processor.make
 
         # Both should produce valid 50x50 images
@@ -108,20 +108,20 @@ describe Paperclip::Thumbnail do
 
         # Large preview with vips (faster for large images)
         vips_processor = described_class.new(@file, {
-          geometry: "200x200>",
-          backend: :vips,
-          style: :preview
-        }, attachment)
+                                               geometry: "200x200>",
+                                               backend: :vips,
+                                               style: :preview,
+                                             }, attachment)
         vips_result = vips_processor.make
 
         @file.rewind
 
         # Small thumbnail with image_magick
         magick_processor = described_class.new(@file, {
-          geometry: "32x32#",
-          backend: :image_magick,
-          style: :icon
-        }, attachment)
+                                                 geometry: "32x32#",
+                                                 backend: :image_magick,
+                                                 style: :icon,
+                                               }, attachment)
         magick_result = magick_processor.make
 
         # Verify dimensions
@@ -186,11 +186,9 @@ describe Paperclip::Thumbnail do
 
       context "with vips backend" do
         before do
-          begin
-            require "vips"
-          rescue LoadError
-            skip "libvips not installed"
-          end
+          require "vips"
+        rescue LoadError
+          skip "libvips not installed"
         end
 
         it "resizes image to specified dimensions" do
@@ -216,7 +214,7 @@ describe Paperclip::Thumbnail do
           # Verify it detects logical dimensions (rotated from 300x200 to 200x300)
           expect(processor.current_geometry.width).to eq(200)
           result = processor.make
-        
+
           cmd = %[identify -format "%wx%h" "#{result.path}"]
           # Original 300x200 with orientation 6 (90 deg CW).
           # Post autorot: 200x300.
@@ -225,7 +223,8 @@ describe Paperclip::Thumbnail do
         end
 
         it "strips metadata when requested via convert_options" do
-          processor = described_class.new(@file, { geometry: "50x50", convert_options: "-strip", backend: :vips }, attachment)
+          processor = described_class.new(@file, { geometry: "50x50", convert_options: "-strip", backend: :vips },
+                                          attachment)
           result = processor.make
 
           # identify -verbose shows less output when stripped
@@ -407,10 +406,10 @@ describe Paperclip::Thumbnail do
           # -strip is cross-platform, should work without warning
           expect(Paperclip).not_to receive(:log).with(/Warning/)
           processor = described_class.new(@file, {
-            geometry: "50x50",
-            backend: :vips,
-            convert_options: "-strip",
-          }, attachment)
+                                            geometry: "50x50",
+                                            backend: :vips,
+                                            convert_options: "-strip",
+                                          }, attachment)
           processor.make
         end
 
@@ -424,10 +423,10 @@ describe Paperclip::Thumbnail do
           # -density is ImageMagick-only, should warn
           expect(Paperclip).to receive(:log).with(/Warning.*density.*not supported.*vips/)
           processor = described_class.new(@file, {
-            geometry: "50x50",
-            backend: :vips,
-            convert_options: "-density 150",
-          }, attachment)
+                                            geometry: "50x50",
+                                            backend: :vips,
+                                            convert_options: "-density 150",
+                                          }, attachment)
           processor.make
         end
       end
@@ -439,10 +438,10 @@ describe Paperclip::Thumbnail do
       # Helper to create a thumbnail with specific convert_options
       def make_thumb_with_options(file, options_string)
         thumb = Paperclip::Thumbnail.new(file, {
-          geometry: "100x100",
-          convert_options: options_string,
-          backend: :image_magick,
-        }, attachment)
+                                           geometry: "100x100",
+                                           convert_options: options_string,
+                                           backend: :image_magick,
+                                         }, attachment)
         thumb.make
       end
 
@@ -576,11 +575,11 @@ describe Paperclip::Thumbnail do
           # Use JPEG to test interlacing (PNG reports format name instead)
           file = File.new(fixture_file("rotated.jpg"), "rb")
           thumb = Paperclip::Thumbnail.new(file, {
-            geometry: "100x100",
-            convert_options: "-interlace Plane",
-            backend: :image_magick,
-            format: :jpg,
-          }, attachment)
+                                             geometry: "100x100",
+                                             convert_options: "-interlace Plane",
+                                             backend: :image_magick,
+                                             format: :jpg,
+                                           }, attachment)
           result = thumb.make
 
           interlace = `identify -format "%[interlace]" "#{result.path}"`.strip
@@ -602,10 +601,10 @@ describe Paperclip::Thumbnail do
           # Use a square image for predictable crop results
           file = File.new(fixture_file("50x50.png"), "rb")
           thumb = Paperclip::Thumbnail.new(file, {
-            geometry: "50x50",  # Keep original size
-            convert_options: "-crop 25x25+0+0 +repage",
-            backend: :image_magick,
-          }, attachment)
+                                             geometry: "50x50", # Keep original size
+                                             convert_options: "-crop 25x25+0+0 +repage",
+                                             backend: :image_magick,
+                                           }, attachment)
           result = thumb.make
 
           dimensions = `identify -format "%wx%h" "#{result.path}"`.strip
@@ -759,11 +758,9 @@ describe Paperclip::Thumbnail do
       let(:attachment) { double("Attachment", options: {}) }
 
       before do
-        begin
-          require "vips"
-        rescue LoadError
-          skip "libvips not installed"
-        end
+        require "vips"
+      rescue LoadError
+        skip "libvips not installed"
       end
 
       # Helper to create a thumbnail with vips backend and specific convert_options
@@ -1211,8 +1208,11 @@ describe Paperclip::Thumbnail do
           end
 
           def width; 100; end
+
           def height; 100; end
+
           def modifier; nil; end
+
           def auto_orient; end
         end
 
@@ -1237,7 +1237,9 @@ describe Paperclip::Thumbnail do
           end
 
           def width; 151; end
+
           def height; 167; end
+
           def modifier; nil; end
         end
 
@@ -1403,7 +1405,7 @@ describe Paperclip::Thumbnail do
           @file,
           geometry: "50x50",
           frame_index: 5,
-          format: :jpg
+          format: :jpg,
         )
       end
 
@@ -1415,11 +1417,9 @@ describe Paperclip::Thumbnail do
 
     context "with vips backend" do
       before do
-        begin
-          require "vips"
-        rescue LoadError
-          skip "libvips not installed"
-        end
+        require "vips"
+      rescue LoadError
+        skip "libvips not installed"
       end
 
       it "preserves animation when output is GIF" do
@@ -1431,7 +1431,8 @@ describe Paperclip::Thumbnail do
       end
 
       it "collapses animation when animated: false is set" do
-        processor = Paperclip::Thumbnail.new(@file, { geometry: "50x50", format: :gif, animated: false, backend: :vips })
+        processor = Paperclip::Thumbnail.new(@file,
+                                             { geometry: "50x50", format: :gif, animated: false, backend: :vips })
         dst = processor.make
         cmd = %[identify -format "%wx%h," "#{dst.path}"]
         frames = `#{cmd}`.chomp.split(",").reject(&:empty?)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jr-paperclip
 version: !ruby/object:Gem::Version
-  version: 8.0.0.beta.1
+  version: 8.0.0.beta.2
 platform: ruby
 authors:
 - Jukka Rautanen
@@ -533,6 +533,7 @@ files:
 - spec/paperclip/matchers/validate_attachment_size_matcher_spec.rb
 - spec/paperclip/media_type_spoof_detector_spec.rb
 - spec/paperclip/meta_class_spec.rb
+- spec/paperclip/migration_guide_example_spec.rb
 - spec/paperclip/paperclip_missing_attachment_styles_spec.rb
 - spec/paperclip/paperclip_spec.rb
 - spec/paperclip/plural_cache_spec.rb
@@ -673,6 +674,7 @@ test_files:
 - spec/paperclip/matchers/validate_attachment_size_matcher_spec.rb
 - spec/paperclip/media_type_spoof_detector_spec.rb
 - spec/paperclip/meta_class_spec.rb
+- spec/paperclip/migration_guide_example_spec.rb
 - spec/paperclip/paperclip_missing_attachment_styles_spec.rb
 - spec/paperclip/paperclip_spec.rb
 - spec/paperclip/plural_cache_spec.rb