imgproxy 1.2.0 → 2.0.0

data/lib/imgproxy/options_aliases.rb

@@ -0,0 +1,43 @@
+module Imgproxy
+  OPTIONS_ALIASES = {
+    resize: :rs,
+    size: :s,
+    resizing_type: :rt,
+    resizing_algorithm: :ra,
+    width: :w,
+    height: :h,
+    enlarge: :en,
+    extend: :ex,
+    gravity: :g,
+    crop: :c,
+    padding: :pd,
+    trim: :t,
+    rotate: :rot,
+    quality: :q,
+    max_bytes: :mb,
+    background: :bg,
+    background_alpha: :bga,
+    adjust: :a,
+    brightness: :br,
+    contrast: :co,
+    saturation: :sa,
+    blur: :bl,
+    sharpen: :sh,
+    pixelate: :pix,
+    unsharpening: :ush,
+    watermark: :wm,
+    watermark_url: :wmu,
+    style: :st,
+    jpeg_options: :jpego,
+    png_options: :pngo,
+    gif_options: :gifo,
+    page: :pg,
+    video_thumbnail_second: :vts,
+    preset: :pr,
+    cachebuster: :cb,
+    strip_metadata: :sm,
+    strip_color_profile: :scp,
+    auto_rotate: :ar,
+    filename: :fn,
+  }.freeze
+end

data/lib/imgproxy/options_casters/adjust.rb

@@ -0,0 +1,22 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/integer"
+require "imgproxy/options_casters/float"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts gravity option
+    module Adjust
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        brightness: Imgproxy::OptionsCasters::Integer,
+        contrast: Imgproxy::OptionsCasters::Float,
+        saturation: Imgproxy::OptionsCasters::Float,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        CASTER.cast(raw)
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/array.rb

@@ -0,0 +1,12 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts array option
+    module Array
+      def self.cast(raw)
+        return if raw.nil?
+
+        raw.is_a?(Array) ? raw : [raw]
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/base64.rb

@@ -0,0 +1,12 @@
+require "base64"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts string option to base64
+    module Base64
+      def self.cast(raw)
+        ::Base64.urlsafe_encode64(raw.to_s).tr("=", "") unless raw.nil?
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/bool.rb

@@ -0,0 +1,12 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts boolean option
+    module Bool
+      def self.cast(raw)
+        return if raw.nil?
+
+        raw && raw != 0 && raw != "0" ? 1 : 0
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/crop.rb

@@ -0,0 +1,23 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/gravity"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts crop option
+    module Crop
+      using TrimArray
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:width] || raw[:height]
+
+        [
+          Imgproxy::OptionsCasters::Float.cast(raw[:width]) || 0,
+          Imgproxy::OptionsCasters::Float.cast(raw[:height]) || 0,
+          Imgproxy::OptionsCasters::Gravity.cast(raw[:gravity]),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/extend.rb

@@ -0,0 +1,26 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/gravity"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts extend option
+    module Extend
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        extend: Imgproxy::OptionsCasters::Bool,
+        gravity: Imgproxy::OptionsCasters::Gravity,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow extend to be just a boolean
+        return Imgproxy::OptionsCasters::Bool.cast(raw) if [true, false].include?(raw)
+
+        return raw unless raw.is_a?(Hash)
+        return if raw[:extend].nil?
+
+        values = CASTER.cast(raw)
+        values[0].zero? ? 0 : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/float.rb

@@ -0,0 +1,16 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts float option
+    module Float
+      ZERO_RE = /\.0+/.freeze
+
+      def self.cast(raw)
+        raw&.to_f&.yield_self do |f|
+          # Convert integral value to Integer so to_s won't give us trailing zero
+          i = f.to_i
+          i == f ? i : f
+        end
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/gif_options.rb

@@ -0,0 +1,21 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts gif_options option
+    module GifOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        optimize_frames: Imgproxy::OptionsCasters::Bool,
+        optimize_transparency: Imgproxy::OptionsCasters::Bool,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/gravity.rb

@@ -0,0 +1,23 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/float"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts gravity option
+    module Gravity
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        type: Imgproxy::OptionsCasters::String,
+        x_offset: Imgproxy::OptionsCasters::Float,
+        y_offset: Imgproxy::OptionsCasters::Float,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:type]
+
+        CASTER.cast(raw)
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/group.rb

@@ -0,0 +1,21 @@
+require "imgproxy/trim_array"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts group of options and trim nils from the end
+    class Group
+      using TrimArray
+
+      def initialize(extractors)
+        @extractors = extractors
+      end
+
+      def cast(raw)
+        values = @extractors.map do |key, extractor|
+          extractor.cast(raw[key])
+        end
+        values.trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/integer.rb

@@ -0,0 +1,10 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts integer option
+    module Integer
+      def self.cast(raw)
+        raw&.to_i
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/jpeg_options.rb

@@ -0,0 +1,26 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts jpeg_options option
+    module JpegOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        progressive: Imgproxy::OptionsCasters::Bool,
+        no_subsample: Imgproxy::OptionsCasters::Bool,
+        trellis_quant: Imgproxy::OptionsCasters::Bool,
+        overshoot_deringing: Imgproxy::OptionsCasters::Bool,
+        optimize_scans: Imgproxy::OptionsCasters::Bool,
+        quant_table: Imgproxy::OptionsCasters::Integer,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/png_options.rb

@@ -0,0 +1,23 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts png_options option
+    module PngOptions
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        interlaced: Imgproxy::OptionsCasters::Bool,
+        quantize: Imgproxy::OptionsCasters::Bool,
+        quantization_colors: Imgproxy::OptionsCasters::Integer,
+      ).freeze
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        values = CASTER.cast(raw)
+        values.empty? ? nil : values
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/resize.rb

@@ -0,0 +1,21 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/size"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts resize option
+    module Resize
+      using TrimArray
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        [
+          Imgproxy::OptionsCasters::String.cast(raw[:resizing_type]) || "fit",
+          *Imgproxy::OptionsCasters::Size.cast(raw),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/size.rb

@@ -0,0 +1,24 @@
+require "imgproxy/trim_array"
+require "imgproxy/options_casters/integer"
+require "imgproxy/options_casters/bool"
+require "imgproxy/options_casters/extend"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts size option
+    module Size
+      using TrimArray
+
+      def self.cast(raw)
+        return raw unless raw.is_a?(Hash)
+
+        [
+          Imgproxy::OptionsCasters::Integer.cast(raw[:width]) || 0,
+          Imgproxy::OptionsCasters::Integer.cast(raw[:height]) || 0,
+          Imgproxy::OptionsCasters::Bool.cast(raw[:enlarge]),
+          Imgproxy::OptionsCasters::Extend.cast(raw[:extend]),
+        ].trim!
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/string.rb

@@ -0,0 +1,10 @@
+module Imgproxy
+  module OptionsCasters
+    # Casts string option
+    module String
+      def self.cast(raw)
+        raw&.to_s
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/trim.rb

@@ -0,0 +1,28 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/bool"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts trim option
+    module Trim
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        threshold: Imgproxy::OptionsCasters::Float,
+        color: Imgproxy::OptionsCasters::String,
+        equal_hor: Imgproxy::OptionsCasters::Bool,
+        equal_ver: Imgproxy::OptionsCasters::Bool,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow trim to be just a numeric
+        return Imgproxy::OptionsCasters::Float.cast(raw) if raw.is_a?(Numeric)
+
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:threshold]
+
+        CASTER.cast(raw)
+      end
+    end
+  end
+end

data/lib/imgproxy/options_casters/watermark.rb

@@ -0,0 +1,30 @@
+require "imgproxy/options_casters/group"
+require "imgproxy/options_casters/float"
+require "imgproxy/options_casters/string"
+require "imgproxy/options_casters/integer"
+
+module Imgproxy
+  module OptionsCasters
+    # Casts string option
+    module Watermark
+      CASTER = Imgproxy::OptionsCasters::Group.new(
+        opacity: Imgproxy::OptionsCasters::Float,
+        position: Imgproxy::OptionsCasters::String,
+        x_offset: Imgproxy::OptionsCasters::Integer,
+        y_offset: Imgproxy::OptionsCasters::Integer,
+        scale: Imgproxy::OptionsCasters::Float,
+      ).freeze
+
+      def self.cast(raw)
+        # Allow watermark to be just a numeric
+        return Imgproxy::OptionsCasters::Float.cast(raw) if raw.is_a?(Numeric)
+
+        return raw unless raw.is_a?(Hash)
+        return unless raw[:opacity]
+
+        values = CASTER.cast(raw)
+        values[0].zero? ? 0 : values
+      end
+    end
+  end
+end

data/lib/imgproxy/trim_array.rb

@@ -0,0 +1,11 @@
+module Imgproxy
+  # `Array.trim!` refinement
+  module TrimArray
+    refine Array do
+      def trim!
+        delete_at(-1) while !empty? && last.nil?
+        self
+      end
+    end
+  end
+end