vitals_image 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84a3011e3da96900b519bb6ce6055c82fcbcca849afc9848d3a1d997132a5b32
+  data.tar.gz: 744defafc94c3ec847f170fd77b38e714ff3b6c1e9960eb921b3464ae8726efd
+SHA512:
+  metadata.gz: 0554f9fa24c1e86a49732d56ca4521df497986e45e246bf94bc278ed23ffa582968def6122627bfd8e949eef6845ab20d69ec837dbc892fd75464e5e8e250afd
+  data.tar.gz: 2234ac3485c84b894794ca313b4e5ca18d7ff2c9f0c7efbb5133bbda95684fc5ce81c0d28ef61c902a5c36a9ae2f85b5b9945bf12c5d61328fff01fe992fa6e6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Breno Gazzola
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/vitals_image_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/vitals_image .css

data/app/assets/stylesheets/vitals_image/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/vitals_image/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/vitals_image/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  module ApplicationHelper
+  end
+end

data/app/helpers/vitals_image/tag_helper.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  module TagHelper
+    def vitals_image_tag(source, options = {})
+      source = image_url(source) if source.is_a?(String)
+      optimizer = VitalsImage::Base.optimizer(source, options)
+
+      if !optimizer.variable?
+        vitals_image_invariable_tag(optimizer)
+      elsif optimizer.native_lazy_load?
+        vitals_image_variable_tag(optimizer)
+      else
+        vitals_image_lazy_tag(optimizer)
+      end
+    end
+
+    private
+      def vitals_image_invariable_tag(optimizer)
+        image_tag optimizer.src, optimizer.html_options
+      end
+
+      def vitals_image_variable_tag(optimizer)
+        url = vitals_image_url(optimizer.src, optimizer.html_options)
+        image_tag url, optimizer.html_options
+      end
+
+      def vitals_image_lazy_tag(optimizer)
+        url = vitals_image_url(optimizer.html_options["data"]["src"], optimizer.html_options)
+        optimizer.html_options["data"]["src"] = url
+
+        image_tag optimizer.src, optimizer.html_options
+      end
+
+      def vitals_image_url(source, options)
+        active_storage_route = options.delete("active_storage_route") || VitalsImage.active_storage_route
+
+        case active_storage_route
+        when :redirect
+          rails_storage_redirect_path(source)
+        when :proxy
+          rails_storage_proxy_path(source)
+        when :public
+          source.is_a?(ActiveStorage::VariantWithRecord) ? source.processed.url : source.url
+        else
+          url_for(source)
+        end
+      end
+  end
+end

data/app/jobs/vitals_image/analyze_job.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class AnalyzeJob < ApplicationJob
+    queue_as { ActiveStorage.queues[:analysis] }
+
+    def perform(source)
+      VitalsImage::Base.analyzer(source).analyze
+    end
+  end
+end

data/app/jobs/vitals_image/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/vitals_image/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/vitals_image/source.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Source < ApplicationRecord
+    store :metadata, accessors: [ :analyzed, :width, :height ], coder: ActiveRecord::Coders::JSON, default: "{ analyzed: false }"
+
+    after_create -> { AnalyzeJob.perform_later(self) }
+  end
+end

data/app/views/layouts/vitals_image/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Vitals image</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "vitals_image/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+VitalsImage::Engine.routes.draw do
+end

data/db/migrate/20210502132155_create_vitals_image_sources.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateVitalsImageSources < ActiveRecord::Migration[6.1]
+  def change
+    create_table :vitals_image_sources do |t|
+      t.string :key, null: false
+      t.string :content_type
+      t.text   :metadata
+
+      t.timestamps
+
+      t.index [ :key ], unique: true
+    end
+  end
+end

data/lib/tasks/vitals_image_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :vitals_image do
+#   # Task goes here
+# end

data/lib/vitals_image.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "vitals_image/version"
+require "vitals_image/engine"
+
+module VitalsImage
+  extend ActiveSupport::Autoload
+
+  autoload :FixtureSet
+
+
+  mattr_accessor :logger
+  mattr_accessor :optimizers
+  mattr_accessor :analyzers
+  mattr_accessor :image_library
+
+  mattr_accessor :mobile_width
+  mattr_accessor :desktop_width
+  mattr_accessor :resolution
+  mattr_accessor :lazy_loading
+  mattr_accessor :lazy_loading_placeholder
+  mattr_accessor :require_alt_attribute
+
+  mattr_accessor :replace_active_storage_analyzer
+  mattr_accessor :check_for_white_background
+
+  mattr_accessor :convert_to_jpeg
+  mattr_accessor :jpeg_conversion
+  mattr_accessor :jpeg_optimization
+  mattr_accessor :png_optimization
+  mattr_accessor :active_storage_route
+
+  mattr_accessor :skip_ssl_verification
+end

data/lib/vitals_image/analyzer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  # This is an abstract base class for dimension calculators
+  class Analyzer
+    attr_reader :source
+
+    # Implement this method in a concrete subclass. Have it return true when given a source from which
+    # it can calculate dimensions
+    def self.accept?(source)
+      false
+    end
+
+    def initialize(source)
+      @source = source
+    end
+
+    def logger
+      VitalsImage.logger
+    end
+  end
+end

data/lib/vitals_image/analyzer/url.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "open-uri"
+
+module VitalsImage
+  class Analyzer::Url < Analyzer
+    def self.accept?(source)
+      source.is_a?(Source)
+    end
+
+    def analyze
+      file = download
+      image = open(file)
+      mime  = Marcel::MimeType.for(Pathname.new file.path)
+
+      source.update width: image.width, height: image.height, analyzed: true, content_type: mime
+    end
+
+    private
+      def open(file)
+        if VitalsImage.image_library == :mini_magick
+          MiniMagick::Image.new(file.path).tap do |image|
+            raise "Invalid image" unless image.valid?
+          end
+        else
+          Vips::Image.new_from_file(file.path, access: :sequential).tap do |image|
+            image.avg
+          end
+        end
+      end
+
+      def download
+        uri = URI.parse(source.key)
+        io = uri.open(ssl_verify_mode: ssl_verify_mode)
+        downloaded = Tempfile.new([File.basename(uri.path), File.extname(uri.path)])
+
+        if io.is_a?(Tempfile)
+          FileUtils.mv io.path, downloaded.path
+        else
+          # StringIO
+          File.write(downloaded.path, io.string)
+        end
+
+        downloaded
+      rescue
+        logger.error "Failed to download #{source.key}"
+        raise
+      end
+
+      def ssl_verify_mode
+        VitalsImage.skip_ssl_verification ? OpenSSL::SSL::VERIFY_NONE : nil
+      end
+  end
+end

data/lib/vitals_image/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Base
+    TINY_GIF = "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
+
+    def self.optimizer(object, options = {})
+      klass = VitalsImage.optimizers.detect { |optimizer| optimizer.accept?(object) }
+      raise UnoptimizableError, "Object is not supported: #{object.class}" unless klass
+
+      klass.new(object, options)
+    end
+
+    def self.analyzer(object)
+      klass = VitalsImage.analyzers.detect { |analyzer| analyzer.accept?(object) }
+      raise UnanalyzableError, "Object is not supported: #{object.class}" unless klass
+
+      klass.new(object)
+    end
+  end
+end

data/lib/vitals_image/cache.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Cache
+    include Singleton
+
+    def initialize
+      @store = ActiveSupport::Cache::MemoryStore.new
+    end
+
+    def locate(key)
+      source = @store.read(key)
+
+      if source.blank?
+        source = Source.create_or_find_by(key: key)
+        expires_in = source.analyzed ? nil : 1.minute
+        @store.write(key, source, expires_in: expires_in)
+      end
+
+      source
+    end
+  end
+end

data/lib/vitals_image/core_extensions/active_storage/image_analyzer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  module CoreExtensions
+    module ActiveStorage
+      class ImageAnalyzer < ::ActiveStorage::Analyzer
+        def self.accept?(blob)
+          blob.image?
+        end
+
+        def metadata
+          read_image do |image|
+            if rotated_image?(image)
+              { width: image.height, height: image.width }
+            else
+              { width: image.width, height: image.height }
+            end
+          end
+        end
+
+        private
+          def read_image
+            download_blob_to_tempfile do |file|
+              require "ruby-vips"
+              image = Vips::Image.new_from_file(file.path, access: :sequential)
+
+              if valid_image?(image)
+                yield image
+              else
+                logger.info "Skipping image analysis because Vips doesn't support the file"
+                {}
+              end
+            end
+          rescue LoadError
+            logger.info "Skipping image analysis because the ruby-vips gem isn't installed"
+            {}
+          rescue Vips::Error => error
+            logger.error "Skipping image analysis due to an Vips error: #{error.message}"
+            {}
+          end
+
+          ROTATIONS = /Right-top|Left-bottom|Top-right|Bottom-left/
+
+          def rotated_image?(image)
+            ROTATIONS === image.get("exif-ifd0-Orientation")
+          rescue ::Vips::Error
+            false
+          end
+
+          def valid_image?(image)
+            image.avg
+            true
+          rescue ::Vips::Error
+            false
+          end
+      end
+    end
+  end
+end

data/lib/vitals_image/core_extensions/active_storage/isolated_image_analyzer.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  module CoreExtensions
+    module ActiveStorage
+      class IsolatedImageAnalyzer < ImageAnalyzer
+        def metadata
+          read_image do |image|
+            if rotated_image?(image)
+              { width: image.height, height: image.width, isolated: isolated?(image) }
+            else
+              { width: image.width, height: image.height, isolated: isolated?(image) }
+            end
+          end
+        end
+
+        private
+          def isolated?(image)
+            corners = extract_corner_areas(image)
+            colors  = corners.map { |corner| primary_color_for(corner) }
+            colors.all? { |color| color.all? { |value| value > 250 } }
+          rescue
+            false
+          end
+
+          def extract_corner_areas(image)
+            paths = []
+
+            basename = SecureRandom.urlsafe_base64
+            width    = image.width
+            height   = image.height
+            size     = 8
+
+            filename = Rails.root.join("tmp", "#{basename}.jpg")
+            `vips copy #{image.filename} #{filename}`
+
+            paths << Rails.root.join("tmp", "#{basename}_top_left.jpg")
+            `vips im_extract_area #{filename} #{paths.last} 0 0 #{size} #{size}`
+
+            paths << Rails.root.join("tmp", "#{basename}_top_right.jpg")
+            `vips im_extract_area #{filename} #{paths.last} #{width - size} 0 #{size} #{size}`
+
+            paths << Rails.root.join("tmp", "#{basename}_bottom_right.jpg")
+            `vips im_extract_area #{filename} #{paths.last} #{width - size} #{height - size} #{size} #{size}`
+
+            paths << Rails.root.join("tmp", "#{basename}_bottom_left.jpg")
+            `vips im_extract_area #{filename} #{paths.last} 0 #{height - size} #{size} #{size}`
+
+            paths
+          end
+
+          def primary_color_for(filepath)
+            histogram = generate_color_histogram(filepath)
+            sorted    = sort_by_frequency(histogram)
+            extract_dominant_rgb(sorted)
+          end
+
+          def generate_color_histogram(path)
+            `convert #{path} +dither -colors 5 -define histogram:unique-colors=true -format "%c" histogram:info:`
+          end
+
+          def sort_by_frequency(histogram)
+            histogram.each_line.map { |line| parts = line.split(":"); [parts[0].to_i, parts[1]] }.sort_by { |line| line[0] }.reverse
+          end
+
+          def extract_dominant_rgb(array)
+            array.map { |line| line[1].match(/\(([\d.,]+)/).captures.first.split(",").take(3).map(&:to_i) }.first
+          end
+      end
+    end
+  end
+end

data/lib/vitals_image/engine.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "active_job"
+require "active_model"
+require "active_record"
+require "active_storage"
+require "active_support"
+
+require "marcel"
+require "ruby-vips"
+require "mini_magick"
+
+require "vitals_image/analyzer"
+require "vitals_image/analyzer/url"
+require "vitals_image/base"
+require "vitals_image/cache"
+require "vitals_image/errors"
+require "vitals_image/optimizer"
+require "vitals_image/optimizer/blank"
+require "vitals_image/optimizer/url"
+require "vitals_image/optimizer/active_storage"
+
+module VitalsImage
+  class Engine < ::Rails::Engine
+    isolate_namespace VitalsImage
+
+    config.vitals_image                                 = ActiveSupport::OrderedOptions.new
+    config.vitals_image.optimizers                      = [VitalsImage::Optimizer::Blank, VitalsImage::Optimizer::ActiveStorage, VitalsImage::Optimizer::Url]
+    config.vitals_image.analyzers                       = [VitalsImage::Analyzer::Url]
+
+    config.eager_load_namespaces << VitalsImage
+
+    initializer "vitals_image.configs" do
+      config.after_initialize do |app|
+        VitalsImage.logger                          = app.config.vitals_image.logger || Rails.logger
+        VitalsImage.optimizers                      = app.config.vitals_image.optimizers || []
+        VitalsImage.analyzers                       = app.config.vitals_image.analyzers || []
+        VitalsImage.image_library                   = app.config.vitals_image.image_library || :mini_magick
+
+        VitalsImage.mobile_width                    = app.config.vitals_image.mobile_width || :original
+        VitalsImage.desktop_width                   = app.config.vitals_image.desktop_width || :original
+        VitalsImage.resolution                      = app.config.vitals_image.resolution || 2
+        VitalsImage.lazy_loading                    = app.config.vitals_image.lazy_loading || :native
+        VitalsImage.lazy_loading_placeholder        = app.config.vitals_image.lazy_loading_placeholder || VitalsImage::Base::TINY_GIF
+        VitalsImage.require_alt_attribute           = app.config.vitals_image.require_alt_attribute || false
+
+        VitalsImage.replace_active_storage_analyzer = app.config.vitals_image.replace_active_storage_analyzer || false
+        VitalsImage.check_for_white_background      = app.config.vitals_image.check_for_white_background || false
+
+        VitalsImage.convert_to_jpeg                 = app.config.vitals_image.convert_to_jpeg || false
+        VitalsImage.jpeg_conversion                 = app.config.vitals_image.jpeg_conversion || { sampling_factor: "4:2:0", strip: true, interlace: "JPEG", colorspace: "sRGB", quality: 80, format: "jpg", background: :white, flatten: true, alpha: :off }
+        VitalsImage.jpeg_optimization               = app.config.vitals_image.jpeg_optimization || { sampling_factor: "4:2:0", strip: true, interlace: "JPEG", colorspace: "sRGB", quality: 80 }
+        VitalsImage.png_optimization                = app.config.vitals_image.png_optimization || { strip: true, quality: 00 }
+        VitalsImage.active_storage_route            = app.config.vitals_image.png_optimization || :inherited
+
+        VitalsImage.skip_ssl_verification           = app.config.vitals_image.skip_ssl_verification || false
+      end
+    end
+
+    initializer "vitals_image.core_extensions" do
+      require_relative "core_extensions/active_storage/image_analyzer"
+      require_relative "core_extensions/active_storage/isolated_image_analyzer"
+
+      config.after_initialize do |app|
+        if VitalsImage.check_for_white_background
+          app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::ImageAnalyzer
+          app.config.active_storage.analyzers.prepend CoreExtensions::ActiveStorage::IsolatedImageAnalyzer
+        elsif VitalsImage.replace_active_storage_analyzer
+          app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::ImageAnalyzer
+          app.config.active_storage.analyzers.prepend CoreExtensions::ActiveStorage::ImageAnalyzer
+        end
+      end
+    end
+
+    initializer "vitals_image.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        helper VitalsImage::TagHelper
+      end
+    end
+  end
+end

data/lib/vitals_image/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  # Generic base class for all VitalsImage exceptions.
+  class Error < StandardError; end
+
+  # Raised when VitalsImage is given a source it cannot optimize
+  class UnoptimizableError < Error; end
+
+  # Raised when VitalsImage is given a source it cannot extract metadata from
+  class UnanalyzableError < Error; end
+
+  # Raised when VitalsImage is given a url that it cannot download a file from
+  class FileNotFoundError < Error; end
+end

data/lib/vitals_image/gem_version.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  # Returns the version of the currently loaded Active Storage as a <tt>Gem::Version</tt>.
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    PRE   = nil
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+  end
+end

data/lib/vitals_image/optimizer.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  # This is an abstract base class for optimizers
+  class Optimizer
+    # Implement this method in a concrete subclass. Have it return true when given a source from which
+    # it can calculate dimensions
+    def self.accept?(source)
+      false
+    end
+
+    def initialize(source, options = {})
+      @source = source
+      @options = options.deep_stringify_keys
+
+      raise ArgumentError, "You must specify an alt for your image" if @options["alt"].blank? && VitalsImage.require_alt_attribute
+    end
+
+    def src
+      if non_native_lazy_load?
+        VitalsImage.lazy_loading_placeholder
+      else
+        source_url
+      end
+    end
+
+    def html_options
+      @html_options ||= begin
+        html_options = @options.dup
+        html_options["width"]           = width
+        html_options["height"]          = height
+        html_options["style"]           = style
+        html_options["class"]           = "vitals-image #{html_options["class"]}".squish
+
+        if non_native_lazy_load?
+          html_options["class"]         = "#{VitalsImage.lazy_loading} #{html_options["class"]}".squish
+          html_options["data"]        ||= {}
+          html_options["data"]["src"]   = source_url
+        elsif lazy_load?
+          html_options["loading"]       = "lazy"
+          html_options["decoding"]      = "async"
+        end
+
+        html_options.compact
+      end
+    end
+
+    def lazy_load?
+      @options["lazy_load"] != false && VitalsImage.lazy_loading
+    end
+
+    def non_native_lazy_load?
+      lazy_load? && VitalsImage.lazy_loading != :native
+    end
+
+    def native_lazy_load?
+      lazy_load? && VitalsImage.lazy_loading == :native
+    end
+
+    # Override this method in a concrete subclass. Have it return true the source is an active storage blob
+    def variable?
+      false
+    end
+
+    private
+      def style
+        if analyzed? && !requested_height
+          "height:auto;"
+        end
+      end
+
+      def width
+        if !analyzed? || fixed_dimensions?
+          requested_width
+        else
+          (original_width * scale).round
+        end
+      end
+
+      def height
+        if !analyzed? || fixed_dimensions?
+          requested_height
+        else
+          (original_height * scale).round
+        end
+      end
+
+
+      def scale
+        [scale_x, scale_y].min
+      end
+
+      def scale_x
+        requested_width ? requested_width / original_width : 1.0
+      end
+
+      def scale_y
+        requested_height ? requested_height / original_height : 1.0
+      end
+
+      def fixed_dimensions?
+        requested_width && requested_height
+      end
+
+      def requested_width
+        @options["width"].to_f if @options["width"]
+      end
+
+      def requested_height
+        @options["height"].to_f if @options["height"]
+      end
+
+
+      # Override this method in a concrete subclass. Have it return true if width and height are available
+      def analyzed?
+        raise NotImplementedError
+      end
+
+      # Override this method in a concrete subclass. Have it return the width of the image
+      def original_width
+        raise NotImplementedError
+      end
+
+      # Override this method in a concrete subclass. Have it return the height of the image
+      def original_height
+        raise NotImplementedError
+      end
+
+
+      # Override this method in a concrete subclass. Have it return the url of the image
+      def source_url
+        raise NotImplementedError
+      end
+  end
+end

data/lib/vitals_image/optimizer/active_storage.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Optimizer::ActiveStorage < Optimizer
+    def self.accept?(source)
+      source.is_a?(::ActiveStorage::Attached) || source.is_a?(::ActiveStorage::Attachment) || source.is_a?(::ActiveStorage::Blob)
+    end
+
+    def variable?
+      true
+    end
+
+    private
+      def source_url
+        if analyzed?
+          variant
+        else
+          @source
+        end
+      end
+
+      def original_width
+        metadata[:width]
+      end
+
+      def original_height
+        metadata[:height]
+      end
+
+      def metadata
+        @source.metadata
+      end
+
+      def analyzed?
+        metadata[:analyzed]
+      end
+
+      def alpha?
+        @options["alpha"]
+      end
+
+      def dimensions
+        if fixed_dimensions?
+          [(requested_width * VitalsImage.resolution).floor, (requested_height * VitalsImage.resolution).floor]
+        elsif VitalsImage.resolution * scale > 1
+          [original_width, original_height]
+        else
+          [(width * VitalsImage.resolution).floor, (height * VitalsImage.resolution).floor]
+        end
+      end
+
+      def resize_mode
+        @options[:resize_mode] || @source.metadata["isolated"] ? :resize_and_pad : :resize_to_fill
+      end
+
+      def variant
+        case (@source.content_type)
+        when /jpg|jpeg/
+          optimize_jpeg
+        when /png/
+          optimize_png
+        else
+          optimize_generic
+        end
+      end
+
+      def optimize_jpeg
+        @source.variant VitalsImage.jpeg_optimization.merge("#{resize_mode}": dimensions)
+      end
+
+      def optimize_png
+        if alpha? || !VitalsImage.convert_to_jpeg
+          @source.variant VitalsImage.png_optimization.merge("#{resize_mode}": dimensions)
+        else
+          @source.variant VitalsImage.jpeg_conversion.merge("#{resize_mode}": dimensions)
+        end
+      end
+
+      def optimize_generic
+        if alpha? || !VitalsImage.convert_to_jpeg
+          @source.variant("#{resize_mode}": dimensions)
+        else
+          @source.variant VitalsImage.jpeg_conversion.merge("#{resize_mode}": dimensions)
+        end
+      end
+  end
+end

data/lib/vitals_image/optimizer/blank.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Optimizer::Blank < Optimizer
+    def self.accept?(source)
+      source.blank?
+    end
+
+    private
+      def source_url
+        VitalsImage.lazy_loading_placeholder
+      end
+
+      def width
+        @options["width"]
+      end
+
+      def height
+        @options["height"]
+      end
+
+      def style
+        nil
+      end
+
+      def lazy_load?
+        false
+      end
+  end
+end

data/lib/vitals_image/optimizer/url.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Optimizer::Url < Optimizer
+    def self.accept?(source)
+      uri = URI.parse(source)
+      %w( http https ).include?(uri.scheme)
+    rescue URI::BadURIError
+      false
+    rescue URI::InvalidURIError
+      false
+    end
+
+    private
+      def source_url
+        @source
+      end
+
+      def style
+        if !analyzed?
+          # Do nothing
+        elsif !requested_height
+          "height:auto;"
+        elsif fixed_dimensions?
+          "object-fit: contain;"
+        end
+      end
+
+      def analyzed?
+        metadata.analyzed
+      end
+
+      def original_width
+        metadata.width
+      end
+
+      def original_height
+        metadata.height
+      end
+
+      def metadata
+        Cache.instance.locate(@source)
+      end
+  end
+end

data/lib/vitals_image/test_case.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module VitalsImage
+  class TestCase < ActiveSupport::TestCase
+    include ViewComponent::TestHelpers
+  end
+end

data/lib/vitals_image/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "gem_version"
+
+module VitalsImage
+  # Returns the version of the currently loaded ActiveStorage as a <tt>Gem::Version</tt>
+  def self.version
+    gem_version
+  end
+end

metadata

@@ -0,0 +1,273 @@
+--- !ruby/object:Gem::Specification
+name: vitals_image
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Breno Gazzola
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: ruby-vips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: platform_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: 
+email:
+- breno@festalab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/config/vitals_image_manifest.js
+- app/assets/stylesheets/vitals_image/application.css
+- app/controllers/vitals_image/application_controller.rb
+- app/helpers/vitals_image/application_helper.rb
+- app/helpers/vitals_image/tag_helper.rb
+- app/jobs/vitals_image/analyze_job.rb
+- app/jobs/vitals_image/application_job.rb
+- app/models/vitals_image/application_record.rb
+- app/models/vitals_image/source.rb
+- app/views/layouts/vitals_image/application.html.erb
+- config/routes.rb
+- db/migrate/20210502132155_create_vitals_image_sources.rb
+- lib/tasks/vitals_image_tasks.rake
+- lib/vitals_image.rb
+- lib/vitals_image/analyzer.rb
+- lib/vitals_image/analyzer/url.rb
+- lib/vitals_image/base.rb
+- lib/vitals_image/cache.rb
+- lib/vitals_image/core_extensions/active_storage/image_analyzer.rb
+- lib/vitals_image/core_extensions/active_storage/isolated_image_analyzer.rb
+- lib/vitals_image/engine.rb
+- lib/vitals_image/errors.rb
+- lib/vitals_image/gem_version.rb
+- lib/vitals_image/optimizer.rb
+- lib/vitals_image/optimizer/active_storage.rb
+- lib/vitals_image/optimizer/blank.rb
+- lib/vitals_image/optimizer/url.rb
+- lib/vitals_image/test_case.rb
+- lib/vitals_image/version.rb
+homepage: https://github.com/FestaLab/vitals_image
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FestaLab/vitals_image
+  source_code_uri: https://github.com/FestaLab/vitals_image
+  changelog_uri: https://github.com/FestaLab/vitals_image/CHANGELOG.mg
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key: 
+specification_version: 4
+summary: Image tags that conform with web vitals
+test_files: []