RubyGems - cloudflare_image_resizing - Versions diffs - 1.0.0 - Mend

cloudflare_image_resizing 1.0.0

Files changed (11) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +22 -0
data/README.md +81 -0
data/Rakefile +8 -0
data/app/helpers/cloudflare_image_resizing/helper.rb +68 -0
data/lib/cloudflare_image_resizing/configuration.rb +11 -0
data/lib/cloudflare_image_resizing/engine.rb +12 -0
data/lib/cloudflare_image_resizing/version.rb +5 -0
data/lib/cloudflare_image_resizing.rb +10 -0
data/lib/tasks/cloudflare_image_resizing_tasks.rake +4 -0
metadata +66 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7660eee22969e295f57dd1dd76a1e0dded9d693fdfe484eade7e77262019e36c
+  data.tar.gz: 54d286cd434e83f9a6c10d6a9df5710abc107ddd30bd52f0abf9f96fd45d5bea
+SHA512:
+  metadata.gz: 2d14c16811c56ed3bb5de587d021d7fd3b9cc0199499a8dd61d351e2d93cb85d31916e569c9458474e76fbac4beafee2bb81c1b7a830c74ab2bbaeb1e075528f
+  data.tar.gz: 55fedb0c72ea3537c13f463ae4a10e85fcfba8c0458aef31afe951997c63cb7bf1d3c3e6225eed16b43e266860b40650e9b8425327e1eced64702a8de3d32883

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+Copyright (c) 2025 Collective Idea
+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 ADDED Viewed

@@ -0,0 +1,81 @@
+[![Gem Version](https://img.shields.io/gem/v/cloudflare_image_resizing.svg)](https://rubygems.org/gems/cloudflare_image_resizing)
+[![CI](https://github.com/collectiveidea/cloudflare_image_resizing/actions/workflows/ci.yml/badge.svg)](https://github.com/collectiveidea/cloudflare_image_resizing/actions/workflows/ci.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+# CloudflareImageResizing
+[Cloudflare's Image Resizing](https://developers.cloudflare.com/images/image-resizing) is a great alternative to resizing images in your Rails app. You get to resize images on-the-fly without adding any load to your server.
+This gem make it easy to pass cloudflare's [resizing settings](https://developers.cloudflare.com/images/image-resizing/url-format/) via a pair of helpers:
+### `resized_image_tag`
+Helper to use `resized_image` and also build an `image_tag`.
+Automatically adds a `srcset` with the same image in 2x and 3x (unless you provide a `srcset`.) See: https://developers.cloudflare.com/images/image-resizing/responsive-images/#srcset-for-high-dpi-displays
+Example usage:
+```ruby
+<%= resized_image_tag(@user.avatar, {width: 100, fit: "crop"}, alt: "Cropped avatar" %>
+```
+### `resized_image`
+Helper return a URL with the applied [resizing settings](https://developers.cloudflare.com/images/image-resizing/url-format/)
+Example usage:
+```ruby
+<%= image_tag resized_image(@user.avatar, width: 100, fit: "crop"), alt: "Cropped avatar" %>
+```
+### Extra option: Preload
+If you pass `preload: true` with the resize options, then add `<%= yield(:cloudflare_image_resizing_preload) %>` to your `<head>`, you will get `<link rel="preload">` for the images.
+### Outside of controllers/views
+You can use the helpers outside of a controller or view, simply `include CloudflareImageResizing::Helper` where you need it.
+### Resizable formats
+Not all formats are resizable. See Cloudflare's docs on [format limitations](https://developers.cloudflare.com/images/image-resizing/format-limitations/)
+tl;dr: these helpers only try to resize `image/jpeg`, `image/gif`, `image/png`, and `image/webp`. Other formats are passed through without resizing.
+## Prerequisites
+* You are using Cloudflare and have Image Resizing enabled.
+* You're using Rails
+* You have images either in ActiveStorage or referenced by a URL.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem "cloudflare_image_resizing"
+```
+## Configuration
+You can use an initializer to configure the `enabled` flag (defaults to `true` for non-local environments, checking `Rails.env.local?`.)
+```ruby
+Rails.application.config.cloudflare_image_resizing.enabled = false
+```
+***Note:*** Image resizing doesn't work from `localhost`, as Cloudflare needs to be able to proxy the request. For that reason, we only enable resizing in production. When disabled, the helpers just return the image path without resize options.
+## Related Reading
+* [Active Storage and Cloudflare’s R2](https://discuss.rubyonrails.org/t/active-storage-and-cloudflares-r2/80819)
+## Contributing
+Open a PR. Be kind. Make the world a better place.
+We built this for our own use cases and many have not run into yours. Let us know of omissions, but be prepared to do the work yourself.
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+require "standard/rake"
+task default: %i[spec standard]

data/app/helpers/cloudflare_image_resizing/helper.rb ADDED Viewed

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+module CloudflareImageResizing
+  module Helper
+    RESIZABLE_CONTENT_TYPES = %w[image/jpeg image/gif image/png image/webp].freeze
+    # Helper to use resized_image and also build an image_tag
+    # Automatically adds a srcset with the same image in 2x and 3x (unless a srcset is provided.)
+    # See: https://developers.cloudflare.com/images/image-resizing/responsive-images/#srcset-for-high-dpi-displays
+    # Example usage:
+    # <%= resized_image_tag @user.avatar, resize: {width: 100, fit: "crop"}, alt: "Cropped avatar" %>
+    def resized_image_tag(image, options = {})
+      resize_options = options.delete(:resize) || {}
+      image_tag(
+        resized_image(image, resize_options),
+        options.reverse_merge(srcset: "#{resized_image(image, resize_options.merge(dpr: 1))},
+        #{resized_image(image, resize_options.merge(dpr: 2))} 2x,
+        #{resized_image(image, resize_options.merge(dpr: 3))} 3x".gsub(/\s+/, " "))
+      )
+    end
+    # Helper to use Cloudflare Image Resizing
+    # https://developers.cloudflare.com/images/image-resizing/url-format/
+    # Example usage:
+    # <%= image_tag resized_image(@user.avatar, width: 100, fit: "crop"), alt: "Cropped avatar" %>
+    def resized_image(image, options)
+      preload = options.delete(:preload)
+      path = if image.is_a?(ActiveStorage::Attachment) || image.is_a?(ActiveStorage::Attached) || image.is_a?(ActionText::Attachment)
+        rails_public_blob_url(image)
+      else
+        image_path(image)
+      end
+      if resizable?(image)
+        if ::Rails.application.config.cloudflare_image_resizing.enabled
+          path = "/" + path unless path.starts_with?("/") # Direct R2 URLs don't have a leading /
+          path = "/cdn-cgi/image/" + options.to_param.tr("&", ",") + path
+        end
+        if preload
+          # Allow us to add a <link rel="preload"> to the head
+          # to speed up loading resized images.
+          content_for(:cloudflare_image_resizing_preload) do
+            preload_link_tag(path, as: :image)
+          end
+        end
+      end
+      path
+    end
+    # Is the image resizable with Cloudflare Image Resizing?
+    # https://developers.cloudflare.com/images/image-resizing/format-limitations/
+    # If we try and it isn't, we get a 415
+    # Someday (supposedly) setting onerror=redirect will make this unnecessary.
+    def resizable?(image)
+      if image.is_a?(ActiveStorage::Attachment) || image.is_a?(ActiveStorage::Attached)
+        image.content_type.in?(RESIZABLE_CONTENT_TYPES)
+      elsif image.is_a?(String)
+        extension = File.extname(image)[1..]
+        Mime::Type.lookup_by_extension(extension).to_s.in?(RESIZABLE_CONTENT_TYPES)
+      else
+        false
+      end
+    end
+  end
+end

data/lib/cloudflare_image_resizing/configuration.rb ADDED Viewed

@@ -0,0 +1,11 @@
+module CloudflareImageResizing
+  class Configuration
+    # Whether to enable resizing. Defaults to true.
+    # Often useful to disable in dev/test environments
+    attr_accessor :enabled
+    def initialize
+      @enabled = ::Rails.env.local?
+    end
+  end
+end

data/lib/cloudflare_image_resizing/engine.rb ADDED Viewed

@@ -0,0 +1,12 @@
+module CloudflareImageResizing
+  class Engine < ::Rails::Engine
+    isolate_namespace CloudflareImageResizing
+    engine_name "cloudflare_image_resizing"
+    config.cloudflare_image_resizing = Configuration.new
+    config.to_prepare do
+      ::ApplicationController.helper(CloudflareImageResizing::Helper)
+    end
+  end
+end

data/lib/cloudflare_image_resizing/version.rb ADDED Viewed

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

data/lib/cloudflare_image_resizing.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+module CloudflareImageResizing
+end
+loader.eager_load

data/lib/tasks/cloudflare_image_resizing_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cloudflare_image_resizing do
+#   # Task goes here
+# end

metadata ADDED Viewed

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: cloudflare_image_resizing
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Morrison
+bindir: bin
+cert_chain: []
+date: 2025-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Easily resize images in Rails using Cloudflare's image resizing service.
+email:
+- daniel@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/helpers/cloudflare_image_resizing/helper.rb
+- lib/cloudflare_image_resizing.rb
+- lib/cloudflare_image_resizing/configuration.rb
+- lib/cloudflare_image_resizing/engine.rb
+- lib/cloudflare_image_resizing/version.rb
+- lib/tasks/cloudflare_image_resizing_tasks.rake
+homepage: https://github.com/collectiveidea/cloudflare_image_resizing
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/collectiveidea/cloudflare_image_resizing
+  source_code_uri: https://github.com/collectiveidea/cloudflare_image_resizing
+  changelog_uri: https://github.com/collectiveidea/cloudflare_image_resizing/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Easily resize images in Rails using Cloudflare's image resizing service.
+test_files: []