imgproxy-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b65c92558467f59a8a6c5d94459875aa1e7b9bcdbb6b97a978af6f91e917e6c
+  data.tar.gz: 56271c6e0cfd75ddcb4f4307e90702eeb5705f886bcee122523594922793350f
+SHA512:
+  metadata.gz: eb8011064eb7798f58d98db9b0dcb2c3d598c6f00c531c5c452836a7ec8ba8a64c8763db4397793058adda12f914c9bd46fd68faf44c113feb9088f786cc3d2d
+  data.tar.gz: eee0ab8edd73aaa2e1f9c9fd064bc6b9b30ea3b015abea239ccfbc1bd45674b85d4b950a2541d133da475846b3c274b89052a83dff592e5b383a40d744b86f69

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change log
+
+## master
+
+- Initial implementation. ([@Bakaface][])
+
+[@palkan]: https://github.com/palkan
+[@Bakaface]: https://github.com/Bakaface

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Evil Martians
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+[![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).
+
+## Installation
+
+Add to your project:
+
+```ruby
+# Gemfile
+gem "imgproxy-rails"
+```
+
+### Supported Ruby versions
+
+- Ruby (MRI) >= 2.7.0
+- JRuby >= 9.3.0
+
+### Supported Rails versions
+
+- Rails >= 6.0.0
+
+## Usage
+
+Given the following configuration:
+
+```ruby
+# development.rb
+config.active_storage.resolve_model_to_route = :rails_storage_proxy
+
+# production.rb
+config.active_storage.resolve_model_to_route = :imgproxy_active_storage
+```
+
+The following HTML snippet will generate different URLs in dev and prod:
+
+```erb
+# show.erb.html
+<%= image_tag Current.user.avatar.variant(resize: "100x100") %>
+```
+
+In dev, it will generate a URL like this:
+
+```html
+<img src="http://localhost:3000/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBWHc9IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--0c35e9a616c29da2dfa10a385bae7172526e7961/me.png">
+```
+
+In prod, it will generate a URL like this:
+
+```html
+<img src="https://imgproxy.example.com/8uVB2dYrZVOdG-1tekFjNJZ7s7VHDViXJbu9TcQavQ8/fn:me.png/aHR0cDovL2xvY2Fs/aG9zdDozMDAwL3Jh/aWxzL2FjdGl2ZV9z/dG9yYWdlL2Jsb2Jz/L3Byb3h5L2V5SmZj/bUZwYkhNaU9uc2li/V1Z6YzJGblpTSTZJ/a0pCYUhCQldIYzlJ/aXdpWlhod0lqcHVk/V3hzTENKd2RYSWlP/aUppYkc5aVgybGtJ/bjE5LS0wYzM1ZTlh/NjE2YzI5ZGEyZGZh/MTBhMzg1YmFlNzE3/MjUyNmU3OTYxL21l/LnBuZw">
+```
+
+You can also specify imgproxy-specific parameters in `imgproxy_options` attribute. Imgproxy-specific params will take precedence over ones from original API:
+
+```ruby
+# height=50 and width=50 will be applied
+Current.user.avatar.variant(resize: "100x100", imgproxy_options: {height: 50, width: 50})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/imgproxy-rails](https://github.com/palkan/imgproxy-rails).
+
+## Credits
+
+This gem is generated via [new-gem-generator](https://github.com/palkan/new-gem-generator).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/imgproxy-rails/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ImgproxyRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/imgproxy-rails/helpers.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ImgproxyRails
+  module Helpers
+    def self.image_variation?(model)
+      model.respond_to?(:variation) &&
+        model.try(:blob)&.content_type&.split("/")&.first == "image"
+    end
+  end
+end

data/lib/imgproxy-rails/transformer.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module ImgproxyRails
+  class Transformer
+    MAP = {
+      resize: proc do |p|
+        width, height = p.split("x")
+        {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) },
+      convert: proc { |p| {format: p} },
+      trim: proc { {trim: 0} },
+      modulate: proc { |p| modulate(p) }
+    }.freeze
+
+    PASSTHROUGH_OPTIONS = Set.new([
+      "rotate",
+      "sharpen",
+      "blur",
+      "quality"
+    ]).freeze
+
+    class << self
+      def call(transformations, meta)
+        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)
+        end
+        mapped_options.merge(passed_options)
+      end
+
+      private
+
+      def convert_color(color)
+        return unless color && color =~ /^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$/
+
+        color.sub(/^#/, "")
+      end
+
+      def resize_and_pad(p, m)
+        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
+
+        if (background = convert_color(options[:background]))
+          result[:background] = background
+        end
+
+        result
+      end
+
+      def modulate(p)
+        brightness, saturation, _ = p.split(",").map(&:to_i)
+
+        result = {}
+        result[:brightness] = brightness if brightness
+        result[:saturation] = saturation if saturation
+
+        result
+      end
+    end
+  end
+end

data/lib/imgproxy-rails/version.rb

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

data/lib/imgproxy-rails.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "imgproxy"
+
+require "imgproxy-rails/engine"
+require "imgproxy-rails/transformer"
+require "imgproxy-rails/helpers"
+require "imgproxy-rails/version"

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: imgproxy-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vladimir Dementyev
+- Albert Pazderin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: imgproxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.3
+- !ruby/object:Gem::Dependency
+  name: image_processing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: A gem that integrates imgproxy.rb with ActiveStorage::Variant API
+email:
+- dementiev.vm@gmail.com
+- afaceisnomore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- 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
+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
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: integration of imgproxy.rb with ActiveStorage::Variant API
+test_files: []