rack_resize 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaecfcc4b1f54da6b128ae9fe7939db1676ab6069a0c15bbedaab5545c74a413
-  data.tar.gz: f7c136233b7a6bbed40c40fca10399139f30ab3393857851690f05593d2b44b4
+  metadata.gz: 78c20cbac58c064a90e81fd8a88114da73f2e69f4ba56ded773fa47bf582349a
+  data.tar.gz: ab003436d413adfac50b26f80732e9c0e97fae5b4a7a3439f4f9ee8e9964d8d3
 SHA512:
-  metadata.gz: 66afe23035cedbf3b32723375b16c75351e1b9d2c6907fa7989b80452181d102b76c719cea27261587e67331739ece84c68c62682791769d4a2c053c36e7d404
-  data.tar.gz: 0b6a7229f59709ca20b55ebeb0efd17cbf9ef8269410a1ae25a6479edb43e90a35294a5930c9d748aba4e5bc8f1bafb313e5a35fc3fd9dd2ce51544ba4a71bef
+  metadata.gz: bc78d25f2d53166bed8c5dcf78367feb7056107c80dbffd700962b99b0472cf1009e04326c242570b96e626252711c818b1d5973a0e59e7f58092bcbdfc5e612
+  data.tar.gz: e37e06c0dfcdd96de655e6822594f63c2693764b66bac9b9c6b9fa185213f4b1352e08441a34c0c5883c2d559b0eae1821f0ac9a6ccfd4dc0ae4a6d74ccd9432

data/README.md

@@ -27,18 +27,23 @@ Fastly / bunny.net format (query string params):
 ```
 /assets/pets/dog.jpg?width=300&height=200&fit=cover&format=webp&quality=85
 ```
+Imgproxy format:
+```
+/insecure/rs:fill:400:300/q:85/f:webp/plain/local:///assets/pets/dog.jpg
+/insecure/rs:fit:200:150/plain/local:///assets/banner.jpg@webp
+```
 
 ### Supported Parameters:
 
-| Parameter  | Shortcut | Type | Description |
-|------------|----------|------|-------------|
-| `width`    | `w`      | integer | Target width in pixels. Scales proportionally if `height` is omitted. |
-| `height`   | `h`      | integer | Target height in pixels. Scales proportionally if `width` is omitted. |
-| `fit`      | —        | string  | Resize mode: `contain` (default), `cover`, `crop`. See below. |
-| `format`   | `f`      | string  | Output format: `jpeg`, `png`, `webp`, `avif`, `gif`. Use `auto` to keep original. |
-| `quality`  | `q`      | integer (1–100) | Compression quality. Defaults to `default_quality` config value (95). |
-| `dpr`      | —        | float (0.1–10) | Device pixel ratio. Multiplies `width` and `height` before processing. |
-| `bg-color` | `bg`     | color   | Background color for flattening transparency. Also aliased as `background`. See formats below. |
+| Parameter  | Shortcut | Imgproxy Option | Type | Description |
+|------------|----------|-----------------|------|-------------|
+| `width`    | `w`      | `w:<val>` or in `rs:<mode>:<w>:<h>` | integer | Target width in pixels. Scales proportionally if `height` is omitted. |
+| `height`   | `h`      | `h:<val>` or in `rs:<mode>:<w>:<h>` | integer | Target height in pixels. Scales proportionally if `width` is omitted. |
+| `fit`      | —        | `rs:fill` (cover), `rs:fit` (contain) | string  | Resize mode: `contain` (default), `cover`, `crop`. See below. |
+| `format`   | `f`      | `f:<fmt>` or `@<fmt>` suffix | string  | Output format: `jpeg`, `png`, `webp`, `avif`, `gif`. Use `auto` to keep original. |
+| `quality`  | `q`      | `q:<val>`       | integer (1–100) | Compression quality. Defaults to `default_quality` config value (95). |
+| `dpr`      | —        | `dpr:<val>`     | float (0.1–10) | Device pixel ratio. Multiplies `width` and `height` before processing. |
+| `bg-color` | `bg`     | `bg:<color>`    | color   | Background color for flattening transparency. Also aliased as `background`. See formats below. |
 
 **Background color formats:**
 - CSS named color: `white`, `red`, `cornflowerblue` (all 148 CSS colors supported)
@@ -51,8 +56,8 @@ Fastly / bunny.net format (query string params):
 Supported by: `vips`, `mini_magick`. Accepted but ignored by `sips` and `imlib2`.
 
 **Fit modes:**
-- `contain` — resizes to fit within the given box, preserving aspect ratio (default)
-- `cover` / `crop` — resizes and center-crops to fill the exact box
+- `contain` (`rs:fit`) — resizes to fit within the given box, preserving aspect ratio (default)
+- `cover` / `crop` (`rs:fill`) — resizes and center-crops to fill the exact box
 
 **Example URLs (query string format):**
 ```
@@ -89,12 +94,36 @@ Supported by: `vips`, `mini_magick`. Accepted but ignored by `sips` and `imlib2`
 /cdn-cgi/image/width=400,format=avif,quality=80/samples/image_1.jpeg
 ```
 
+**Example URLs (Imgproxy format):**
+```
+# Resize to width and height with cover crop (rs:fill)
+/insecure/rs:fill:400:300/plain/local:///samples/image_1.jpeg
+
+# Resize to fit within 400×300 box (rs:fit)
+/insecure/rs:fit:400:300/plain/local:///samples/image_1.jpeg
+
+# Convert format and adjust quality
+/insecure/rs:fill:400:300/q:85/f:webp/plain/local:///samples/image_1.jpeg
+
+# Specify format via extension suffix (@webp)
+/insecure/rs:fit:200:150/plain/samples/banner.jpg@webp
+
+# Using separate width, height, and DPR
+/insecure/w:400/h:300/dpr:2/plain/samples/image_1.jpeg
+
+# Flatten transparency with background color
+/insecure/rs:fill:200:200/bg:white/plain/samples/logo.png
+
+# Rails fingerprint stripping (fingerprinted URL automatically resolves to original file)
+/insecure/w:200/plain/assets/photo-1a2b3c4d.jpg
+```
+
 ### Configuration:
 
 ```ruby
 RackResize.configure do |config|
   config.assets_folders     = { assets: Rails.root.join('app', 'assets', 'images') }
-  config.processor          = :sips / :vips / :mini_magick / :imlib2
+  config.processor          = :sips / :vips / :mini_magick / :imlib2 / :bun_image
   config.default_quality    = 95
   config.save_resized       = false
   config.cache_folder       = Rails.root.join('tmp', 'rack_resize_cache') # used if save_resized enabled
@@ -102,6 +131,21 @@ RackResize.configure do |config|
 end
 ```
 
+### Development vs. Production Architecture:
+
+`rack_resize` lets you write standard CDN / imgproxy URLs in your application code without needing external services running in development:
+
+```
+[ Local Development ]
+Browser Request  -->  Rails / Rack App  -->  RackResize Middleware  -->  Ruby Processor (:vips, :mini_magick, etc.)
+
+[ Production ]
+Browser Request  -->  Nginx / CDN Cache  -->  imgproxy (Go service)  -->  Original Image Storage (S3 / disk)
+```
+
+- **In Development**: Include `rack_resize` in your `:development` Gemfile group. It intercepts `/insecure/...`, `/cdn-cgi/image/...`, or query string parameters, processes images on the fly in Ruby, and serves them immediately.
+- **In Production**: Route image paths directly at your reverse proxy (e.g. Nginx with `proxy_cache`) to your production `imgproxy` container or CDN edge, keeping your web application servers focused on dynamic application traffic.
+
 ### Supported Processing Backends:
 
 <table>
@@ -167,19 +211,31 @@ gem "rszr"
 
 </td>
 </tr>
+<tr>
+<td>bun_image</td>
+<td><code>processor: :bun_image</code></td>
+<td>
+
+Bun ≥ 1.3.14 — `brew install oven-sh/bun/bun`
+
+</td>
+<td>none (shells out to <code>bun</code>)</td>
+</tr>
 </table>
 
+Note: <code>fit=cover</code>/<code>fit=crop</code> falls back to stretch (fill) with <code>bun_image</code> — Bun.Image has no crop yet.
+
 ### Supported Image Formats:
 
-| Format | sips | mini_magick | vips | imlib2 |
-|--------|:----:|:-----------:|:----:|:------:|
-| JPEG   | ✅   | ✅          | ✅   | ✅     |
-| PNG    | ✅   | ✅          | ✅   | ✅     |
-| GIF    | ✅   | ✅          | ✅   | ✅     |
-| WebP   | ❌   | ✅ ¹        | ✅ ¹ | ❌     |
-| AVIF   | ✅ ² | ✅ ³        | ✅ ⁴ | ❌     |
-| HEIC   | ✅   | ✅ ³        | ✅ ⁴ | ❌     |
-| SVG    | ❌   | ✅ ⁵        | ✅ ⁶ | ❌     |
+| Format | sips | mini_magick | vips | imlib2 | bun_image |
+|--------|:----:|:-----------:|:----:|:------:|:---------:|
+| JPEG   | ✅   | ✅          | ✅   | ✅     | ✅        |
+| PNG    | ✅   | ✅          | ✅   | ✅     | ✅        |
+| GIF    | ✅   | ✅          | ✅   | ✅     | ❌        |
+| WebP   | ❌   | ✅ ¹        | ✅ ¹ | ❌     | ✅        |
+| AVIF   | ✅ ² | ✅ ³        | ✅ ⁴ | ❌     | ✅ ⁷      |
+| HEIC   | ✅   | ✅ ³        | ✅ ⁴ | ❌     | ✅ ⁷      |
+| SVG    | ❌   | ✅ ⁵        | ✅ ⁶ | ❌     | ❌        |
 
 ¹ Requires ImageMagick / libvips built with **libwebp** support (`brew install webp`)
 ² macOS 13 (Ventura) or later
@@ -187,6 +243,7 @@ gem "rszr"
 ⁴ Requires libvips built with **libheif** support (`brew install libheif`)
 ⁵ Requires **Inkscape** or **librsvg** (`brew install librsvg`)
 ⁶ Requires libvips built with **librsvg** support (`brew install librsvg`)
+⁷ AVIF/HEIC encode is macOS/Windows only in Bun.Image
 
 ### Performance Benchmarks:
 

data/benchmark/http_benchmark.rb

@@ -28,7 +28,7 @@ NULL_LOGGER  = Logger.new(IO::NULL)
 available_apps = {}
 
 puts "Loading processors..."
-%i[sips vips mini_magick imlib2].each do |name|
+%i[sips vips mini_magick imlib2 bun_image].each do |name|
   begin
     app = RackResize::RackApp.new(
       processor:      name,

data/benchmark/processor_benchmark.rb

@@ -24,6 +24,7 @@ PROCESSOR_CLASSES = {
   vips:        RackResize::Processors::Vips,
   mini_magick: RackResize::Processors::MiniMagick,
   imlib2:      RackResize::Processors::Imlib2,
+  bun_image:   RackResize::Processors::BunImage,
 }.freeze
 
 puts "Loading processors..."

data/lib/rack_resize/configuration.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 
 class RackResize::Configuration
-  PROCESSORS = %i[sips vips mini_magick imlib2].freeze
+  PROCESSORS = %i[sips vips mini_magick imlib2 bun_image].freeze
 
   attr_reader :processor, :assets_folders
   attr_accessor :save_resized, :default_quality, :cache_folder, :http_cache_max_age, :max_dimension, :logger
@@ -63,6 +63,7 @@ class RackResize::Configuration
                             when :vips        then RackResize::Processors::Vips.new
                             when :sips        then RackResize::Processors::Sips.new
                             when :imlib2      then RackResize::Processors::Imlib2.new
+                            when :bun_image   then RackResize::Processors::BunImage.new
                             else
                               raise "RackResize - Unknown image processor #{@processor.inspect}"
                             end

data/lib/rack_resize/input_parsers/imgproxy.rb

@@ -0,0 +1,71 @@
+module RackResize::InputParsers::Imgproxy
+  extend self
+
+  # Supports imgproxy URL formats:
+  # /insecure/rs:fill:400:300/q:85/f:webp/plain/local:///assets/photo.jpg
+  # /insecure/rs:fit:200:150/plain/local:///assets/banner.jpg@webp
+  # /my-sig-123/w:400/h:300/q:80/plain/assets/photo.png
+  # /insecure/plain/local:///assets/photo.jpg@avif
+
+  REGEX = %r{\A/(?<signature>[^/]+)/(?:(?<options>(?:[a-z_]+:[^/]+/)*))plain/(?:local:///?|https?://[^/]+/)?(?<path>[^@\s]+?)(?:@(?<format>\w+))?\z}i
+
+  def parse_input(fullpath)
+    match = fullpath.to_s.match(REGEX)
+    return { route_matched: false, req_params: nil, asset_path: nil } unless match
+
+    req_params = {}
+
+    if match[:options]
+      match[:options].split("/").each do |part|
+        next if part.empty?
+        type, *args = part.split(":")
+        case type.downcase
+        when "rs", "resize"
+          # rs:<type>:<width>:<height>:<enlarge>:<extend>
+          req_params[:fit]    = map_fit(args[0]) if args[0] && !args[0].empty?
+          req_params[:width]  = args[1] if args[1] && !args[1].empty? && args[1] != "0"
+          req_params[:height] = args[2] if args[2] && !args[2].empty? && args[2] != "0"
+        when "w", "width"
+          req_params[:width] = args[0] if args[0] && !args[0].empty?
+        when "h", "height"
+          req_params[:height] = args[0] if args[0] && !args[0].empty?
+        when "dpr"
+          req_params[:dpr] = args[0] if args[0] && !args[0].empty?
+        when "q", "quality"
+          req_params[:quality] = args[0] if args[0] && !args[0].empty?
+        when "f", "format", "ext"
+          req_params[:format] = args[0] if args[0] && !args[0].empty?
+        when "bg", "background"
+          req_params[:background] = args.join(":") if args.any?
+        when "fit"
+          req_params[:fit] = map_fit(args[0]) if args[0] && !args[0].empty?
+        end
+      end
+    end
+
+    if match[:format]
+      req_params[:format] = match[:format]
+    end
+
+    raw_path = match[:path]
+    raw_path = "/" + raw_path unless raw_path.start_with?("/")
+    asset_path = raw_path.sub(/-[\da-f]{8}(?=\.\w{2,}$)/, "")
+
+    { route_matched: true, req_params: req_params, asset_path: asset_path }
+  end
+
+  private
+
+  def map_fit(val)
+    case val.to_s.downcase
+    when "fill", "fill-down", "cover"
+      "cover"
+    when "fit", "contain"
+      "contain"
+    when "force"
+      "fill"
+    else
+      val
+    end
+  end
+end

data/lib/rack_resize/input_parsers/query_string.rb

@@ -8,11 +8,15 @@ module RackResize::InputParsers::QueryString
   #
   # Shortcuts: f=format, q=quality
 
+  IMAGE_EXTENSIONS = %w[.jpg .jpeg .png .webp .gif .avif .svg .heic].freeze
   CANONICAL_PARAMS = %w[width height quality dpr format fit bg-color background].freeze
   PARAM_ALIASES    = { 'f' => :format, 'q' => :quality, 'h' => :height, 'w' => :width, 'bg' => :'bg-color' }.freeze
   RESIZE_PARAMS    = (CANONICAL_PARAMS + PARAM_ALIASES.keys).freeze
 
   def parse_input(fullpath, query_string)
+    ext = File.extname(fullpath.to_s.split('?').first.to_s).downcase
+    return { route_matched: false, req_params: nil, asset_path: nil } unless IMAGE_EXTENSIONS.include?(ext)
+
     params = Rack::Utils.parse_query(query_string.to_s)
 
     unless params.keys.any? { |k| RESIZE_PARAMS.include?(k) }

data/lib/rack_resize/processors/bun_image.js

@@ -0,0 +1,34 @@
+const opts = JSON.parse(Bun.argv[2]);
+const { source, target, width, height, format, quality, fit } = opts;
+
+let img = Bun.file(source).image();
+
+if (width && height) {
+  img = img.resize(width, height, { fit: fit === "fill" ? "fill" : "inside" });
+} else if (width) {
+  img = img.resize(width);
+} else if (height) {
+  // Bun.Image lacks height-only resize; derive width from source aspect ratio.
+  const meta = await img.metadata();
+  const w = Math.max(1, Math.round((meta.width * height) / meta.height));
+  img = new Bun.Image(source).resize(w, height, { fit: "inside" });
+}
+
+const q = quality ?? 85;
+const outFmt = (format || source.split(".").pop()).toLowerCase();
+
+switch (outFmt) {
+  case "jpg":
+  case "jpeg": img = img.jpeg({ quality: q }); break;
+  case "png":  img = img.png(); break;
+  case "webp": img = img.webp({ quality: q }); break;
+  case "avif": img = img.avif({ quality: q }); break;
+  case "heic": img = img.heic({ quality: q }); break;
+  default: throw new Error(`unsupported format: ${outFmt}`);
+}
+
+if (target) {
+  await img.write(target);
+} else {
+  process.stdout.write(await img.bytes());
+}

data/lib/rack_resize/processors/bun_image.rb

@@ -0,0 +1,42 @@
+require "open3"
+require "json"
+require "tempfile"
+
+class RackResize::Processors::BunImage
+  SCRIPT = File.expand_path("bun_image.js", __dir__)
+
+  def resize(source_file:, target_width:, target_height:, target_file: nil, fit: nil, format: nil, quality: nil, bg_color: nil)
+    quality ||= RackResize.config.default_quality
+    cover = (fit == 'cover' || fit == 'crop') && target_width && target_height
+
+    # ponytail: Bun.Image has no crop/extract yet, so `cover` falls back to `fill`
+    # (stretches to exact dims). Upgrade when Bun ships extract() or fit:"cover".
+    bun_fit = cover ? 'fill' : 'inside'
+
+    payload = {
+      source:  source_file.to_s,
+      target:  target_file&.to_s,
+      width:   target_width&.to_i,
+      height:  target_height&.to_i,
+      format:  format && (format.to_s.downcase == 'jpg' ? 'jpeg' : format.to_s.downcase),
+      quality: quality&.to_i,
+      fit:     bun_fit,
+    }
+
+    if target_file
+      run_bun(payload)
+      nil
+    else
+      out, err, status = Open3.capture3("bun", SCRIPT, JSON.generate(payload))
+      raise "bun_image failed: #{err}" unless status.success?
+      out
+    end
+  end
+
+  private
+
+  def run_bun(payload)
+    _, err, status = Open3.capture3("bun", SCRIPT, JSON.generate(payload))
+    raise "bun_image failed: #{err}" unless status.success?
+  end
+end

data/lib/rack_resize/rack_app.rb

@@ -20,6 +20,7 @@ class RackResize::RackApp
 
     result = RackResize::InputParsers::Cloudflare.parse_input(fullpath, cf_path_prefix: @cf_path_prefix)
     result = RackResize::InputParsers::QueryString.parse_input(fullpath, request.query_string) unless result[:route_matched]
+    result = RackResize::InputParsers::Imgproxy.parse_input(fullpath) unless result[:route_matched]
     result => {route_matched:, req_params:, asset_path:}
 
     return @app.call(env) unless route_matched

data/lib/rack_resize.rb

@@ -9,11 +9,13 @@ module RackResize
     autoload :Vips,       "#{__dir__}/rack_resize/processors/vips"
     autoload :MiniMagick, "#{__dir__}/rack_resize/processors/mini_magick"
     autoload :Imlib2,     "#{__dir__}/rack_resize/processors/imlib2"
+    autoload :BunImage,   "#{__dir__}/rack_resize/processors/bun_image"
   end
 
   module InputParsers
     autoload :Cloudflare,  "#{__dir__}/rack_resize/input_parsers/cloudflare"
     autoload :QueryString, "#{__dir__}/rack_resize/input_parsers/query_string"
+    autoload :Imgproxy,    "#{__dir__}/rack_resize/input_parsers/imgproxy"
   end
 
   class << self

data/rack_resize.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "rack_resize"
-  s.version     = "0.1.4"
+  s.version     = "0.1.7"
   s.author      = ["Pavel Evstigneev"]
   s.email       = ["pavel.evst@gmail.com"]
   s.homepage    = "https://github.com/paxa/rack_resize"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack_resize
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - Pavel Evstigneev
@@ -48,8 +48,11 @@ files:
 - lib/rack_resize/color_utils.rb
 - lib/rack_resize/configuration.rb
 - lib/rack_resize/input_parsers/cloudflare.rb
+- lib/rack_resize/input_parsers/imgproxy.rb
 - lib/rack_resize/input_parsers/query_string.rb
 - lib/rack_resize/processing.rb
+- lib/rack_resize/processors/bun_image.js
+- lib/rack_resize/processors/bun_image.rb
 - lib/rack_resize/processors/imlib2.rb
 - lib/rack_resize/processors/mini_magick.rb
 - lib/rack_resize/processors/sips.rb