imgproxy-rails 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b03b90364b582070b6dfbbf0d7b628287286cd3b546096dd5eda2f8bd18ad1c
-  data.tar.gz: 81718d679156b49ff694b6870903fcb042dee30c93dc29ceab49b3774e233f17
+  metadata.gz: b6974de3a0a3e639db48c61d91831744442c8ac5a5d6e9d4525985896e6b2a01
+  data.tar.gz: d081d8571ca8a0cd940839cb97016abf74138158dfe4c0135a45368842c8d007
 SHA512:
-  metadata.gz: beec714e3a4d032def537dde78d3f124871e61fa115e5314073c07a2da4e69247ddcd3a901225c1fff7e39395722192d577c3f1db9007072e7bee293f8293f6d
-  data.tar.gz: 4fd2e8adfa00e4aaaae09a08a62e2ca8e19d7347a0be016eb52157588e0d42dccde7c5fb291480efa03b1c116ab3e6c46afd6a9c446ebef8ac374423059b1707
+  metadata.gz: 7ad05883a46086a42ea605d2f978c9f57ef0da2d412b3c2f0443eddc25e62a93727d975459c69299314522e42176435bcbeed20e7b62ea2ba47c24da2bd9d4c1
+  data.tar.gz: 177fe43bf90c218934bd705d155bc10812493c8e427d8eed10e81561849d443eacd90c453d6e294655b2307ce165d8dad0b155baf6c790cd2b43f72abf6b7e85

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master
 
+## 0.3.0 (2023-12-27)
+
+- Added support for `video/*` and `application/pdf` content types. ([@DarthSim][])
+
+- `config/routes.rb` added to gemspec files ([@chloerei][])
+
+## 0.2.0 (2023-10-26)
+
+- Improved `resize_and_pad` support. ([@palkan][])
+
+- Support short URLs for S3/GCS. ([@palkan][])
+
 ## 0.1.0 (2023-09-21)
 
 - Initial implementation. ([@Bakaface][])

data/README.md

@@ -1,10 +1,24 @@
-[![Gem Version](https://badge.fury.io/rb/imgproxy-rails.svg)](https://rubygems.org/gems/imgproxy-rails)
-[![Build](https://github.com/palkan/imgproxy-rails/workflows/Build/badge.svg)](https://github.com/palkan/imgproxy-rails/actions)
-[![JRuby Build](https://github.com/palkan/imgproxy-rails/workflows/Build%20JRuby/badge.svg)](https://github.com/palkan/imgproxy-rails/actions)
-
-# imgproxy-rails
-
-Integration of [imgproxy.rb](https://github.com/imgproxy/imgproxy.rb) with [ActiveStorage::Variant API](https://edgeapi.rubyonrails.org/classes/ActiveStorage/Variant.htmlasses/ActiveStorage/Variant.html).
+<p align="center">
+  <a href="https://imgproxy.net">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets/logo-dark.svg?sanitize=true">
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets/logo-light.svg?sanitize=true">
+      <img alt="imgproxy logo" src="https://raw.githubusercontent.com/imgproxy/imgproxy/master/assets/logo-light.svg?sanitize=true">
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+<a href="https://github.com/imgproxy/imgproxy-rails/actions"><img alt="GH Test" src="https://img.shields.io/github/actions/workflow/status/imgproxy/imgproxy-rails/rspec.yml?branch=master&label=Test&style=for-the-badge"/></a>
+<a href="https://github.com/imgproxy/imgproxy-rails/actions"><img alt="GH Test Jruby" src="https://img.shields.io/github/actions/workflow/status/imgproxy/imgproxy-rails/rspec-jruby.yml?branch=master&label=Test%20JRuby&style=for-the-badge"/></a>
+<a href="https://github.com/imgproxy/imgproxy-rails/actions"><img alt="GH Lint" src="https://img.shields.io/github/actions/workflow/status/imgproxy/imgproxy-rails/rubocop.yml?branch=master&label=Lint&style=for-the-badge"/></a>
+<a href="https://rubygems.org/gems/imgproxy-rails"><img alt="Gem" src="https://img.shields.io/gem/v/imgproxy-rails.svg?style=for-the-badge"/></a>
+<a href="https://www.rubydoc.info/gems/imgproxy-rails"><img alt="rubydoc.org" src="https://img.shields.io/badge/rubydoc-reference-blue.svg?style=for-the-badge"/></a>
+</p>
+
+---
+
+Integration of [imgproxy.rb](https://github.com/imgproxy/imgproxy.rb) with [ActiveStorage::Variant API](https://edgeapi.rubyonrails.org/classes/ActiveStorage/Variant.html).
 
 ## Installation
 
@@ -62,9 +76,20 @@ You can also specify imgproxy-specific parameters in `imgproxy_options` attribut
 Current.user.avatar.variant(resize: "100x100", imgproxy_options: {height: 50, width: 50})
 ```
 
+### Generating video and PDF previews
+
+If you are an imgproxy Pro user and you want to use it to generate previews for your videos and PDFs, just add their content types to the `variable_content_types` list:
+
+```ruby
+config.active_storage.variable_content_types << "application/pdf"
+config.active_storage.variable_content_types << "video/mp4"
+config.active_storage.variable_content_types << "video/mov"
+# ...etc
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/imgproxy-rails](https://github.com/palkan/imgproxy-rails).
+Bug reports and pull requests are welcome on GitHub at [https://github.com/imgproxy/imgproxy-rails](https://github.com/imgproxy/imgproxy-rails).
 
 ## Credits
 

data/config/routes.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  direct :imgproxy_active_storage do |model, options|
+    if ImgproxyRails::Helpers.applicable_variation?(model)
+      transformations = model.variation.transformations
+      Imgproxy.url_for(model.blob, ImgproxyRails::Transformer.call(transformations))
+    else
+      route_for(:rails_storage_proxy, model, options)
+    end
+  end
+end

data/lib/imgproxy-rails/helpers.rb

@@ -2,9 +2,13 @@
 
 module ImgproxyRails
   module Helpers
-    def self.image_variation?(model)
-      model.respond_to?(:variation) &&
-        model.try(:blob)&.content_type&.split("/")&.first == "image"
+    def self.applicable_variation?(model)
+      return false if !model.respond_to?(:variation)
+
+      content_type = model.try(:blob)&.content_type
+      content_type&.start_with?("image/") ||
+        content_type&.start_with?("video/") ||
+        content_type == "application/pdf"
     end
   end
 end

data/lib/imgproxy-rails/transformer.rb

@@ -8,14 +8,26 @@ module ImgproxyRails
         {width: width, height: height}
       end,
       resize_to_limit: proc { |p| {width: p[0], height: p[1]} },
-      resize_to_fit: proc { |p| {width: p[0], height: p[1]} },
-      resize_to_fill: proc { |p| {width: p[0], height: p[1], resizing_type: :fill} },
-      resize_and_pad: proc { |p, m| resize_and_pad(p, m) },
+      resize_to_fit: proc { |p| {width: p[0], height: p[1], enlarge: true} },
+      resize_to_fill: proc { |p| {width: p[0], height: p[1], resizing_type: :fill, enlarge: true} },
+      resize_and_pad: proc { |p| resize_and_pad(p) },
       convert: proc { |p| {format: p} },
       trim: proc { {trim: 0} },
       modulate: proc { |p| modulate(p) }
     }.freeze
 
+    GRAVITY = {
+      "north" => "no",
+      "north-east" => "noea",
+      "east" => "ea",
+      "south-east" => "soea",
+      "south" => "so",
+      "south-west" => "sowe",
+      "west" => "we",
+      "north-west" => "nowe",
+      "centre" => "ce"
+    }.freeze
+
     PASSTHROUGH_OPTIONS = Set.new([
       "rotate",
       "sharpen",
@@ -24,14 +36,14 @@ module ImgproxyRails
     ]).freeze
 
     class << self
-      def call(transformations, meta)
+      def call(transformations)
         passed_options = transformations.delete(:imgproxy_options) || {}
         mapped_options = transformations.each_with_object({}) do |(t_key, t_value), memo|
           if PASSTHROUGH_OPTIONS.include?(t_key.to_s)
             memo[t_key] = t_value
             next
           end
-          memo.merge!(MAP[t_key].call(t_value, meta)) if MAP.key?(t_key)
+          memo.merge!(MAP[t_key].call(t_value)) if MAP.key?(t_key)
         end
         mapped_options.merge(passed_options)
       end
@@ -44,36 +56,20 @@ module ImgproxyRails
         color.sub(/^#/, "")
       end
 
-      def resize_and_pad(p, m)
+      def resize_and_pad(p)
         target_width, target_height, options = p
         options ||= {}
 
-        result = {width: target_width, height: target_height}
-        return result unless m["width"] && m["height"]
-
-        aspect_ratio = m["width"].to_f / m["height"]
-        if aspect_ratio > 1
-          # add vertical padding
-          final_height = target_width.to_f / aspect_ratio
-          padding_length = ((target_height - final_height) / 2).round
-          result[:padding] = [padding_length, 0]
-
-          # setting min-width for correct upscaling
-          result[:mw] = target_width
-        elsif aspect_ratio < 1
-          # add horizontal padding
-          final_width = target_height.to_f * aspect_ratio
-          padding_length = ((target_width - final_width) / 2).round
-          result[:padding] = [0, padding_length]
-
-          # setting min-height for correct upscaling
-          result[:mh] = target_height
-        end
+        result = {width: target_width, height: target_height, extend: true}
 
         if (background = convert_color(options[:background]))
           result[:background] = background
         end
 
+        if (gravity = GRAVITY[options[:gravity].to_s])
+          result[:extend] = {extend: true, gravity: gravity}
+        end
+
         result
       end
 

data/lib/imgproxy-rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImgproxyRails
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imgproxy-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vladimir Dementyev
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: imgproxy
@@ -148,20 +148,21 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- config/routes.rb
 - lib/imgproxy-rails.rb
 - lib/imgproxy-rails/engine.rb
 - lib/imgproxy-rails/helpers.rb
 - lib/imgproxy-rails/transformer.rb
 - lib/imgproxy-rails/version.rb
-homepage: http://github.com/evilmartians/imgproxy-rails
+homepage: http://github.com/imgproxy/imgproxy-rails
 licenses:
 - MIT
 metadata:
-  bug_tracker_uri: http://github.com/evilmartians/imgproxy-rails/issues
-  changelog_uri: https://github.com/evilmartians/imgproxy-rails/blob/master/CHANGELOG.md
-  documentation_uri: http://github.com/evilmartians/imgproxy-rails
-  homepage_uri: http://github.com/evilmartians/imgproxy-rails
-  source_code_uri: http://github.com/evilmartians/imgproxy-rails
+  bug_tracker_uri: http://github.com/imgproxy/imgproxy-rails/issues
+  changelog_uri: https://github.com/imgproxy/imgproxy-rails/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/imgproxy/imgproxy-rails
+  homepage_uri: http://github.com/imgproxy/imgproxy-rails
+  source_code_uri: http://github.com/imgproxy/imgproxy-rails
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: integration of imgproxy.rb with ActiveStorage::Variant API