vitals_image 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39aa736f9e99bbf581d7e5b2f27df977921428c7aaf95846189475fd5ecc28ca
-  data.tar.gz: e879218f0859db14a8879ef761b88930758e73302d9b1e0e88e4fb7c7e3251a6
+  metadata.gz: 070dabcbfcfe58cf4ad78ed7509cf16963484fa160db4358ed2f400a1a7d7925
+  data.tar.gz: cecf4c19afeed8df374686752e3ee7300ecbe6ced03c15781a9f0caa6134418b
 SHA512:
-  metadata.gz: e6a8f4819b849d25306338f00a3a3691e59acbe12417cfb88b5c5a722914b1d34bdfb792776e51a22f7d4efbed37030f8c35203ca8d4a362e8c0e4213d5776fa
-  data.tar.gz: 5058ad30a14d2edcb8ac744e5d8bb8130c66e0e874a3c088fb15ac297ba5911b8f9e95b19f7f67dbceb8f1a46201a2ed8f56c4b2e9271d7d19ad79476d637bab
+  metadata.gz: 424b3c5908a10ee87df1e8174b786f30166af7b8fc28c4473ca77775dafb77fb1cce5780568a1098efac6898eb4b97584857ea122555d68f81ead1f6b1cfbb5c
+  data.tar.gz: 9510a8c14a5363997d6729933b3356f0bf7145410498e850ccd27d346fbde54e6bdf013e4b6b97afd557279f26dae4e082c07ad188ecdbcdb3e1e3b984c1655e

data/CHANGELOG.md

@@ -1,8 +1,34 @@
 ## [Unreleased]
 
+## [0.5]
+
+- Add `domains` config to allow limiting from which domains images will be analyzed
+- User `after_commit` to enqueued analyze job
+
+## [0.4.1] - 2021-07-22
+
+- Do not discard the specified `style` attribute
+
+## [0.4.0] - 2021-07-06
+
+- Fixed resize and pad in vips
+- Fixed image quality in vips
+- Reduced JPEG quality from 85 to 80
+- Removed optimal quality
+- Updated Vitals Image to 0.5
+
+## [0.3.0] - 2021-05-22
+
+- Redo the image helper
+- Redo the active storage optimizer 
+
+## [0.2.1] - 2021-05-22
+
+- Do not attempt to transform invariable images
+
 ## [0.2.0] - 2021-05-18
 
-- Use the `optimial_quality` value of blob metadata instead of fixed `85` if its available;
+- Use the `optimal_quality` value of blob metadata instead of fixed `85` if its available;
 - Remove some unecessary configs;
 - Drop analyzers and use `active_analysis` gem instead;
 - Use "retry once" strategy instead of `create_or_find_by`; 

data/README.md

@@ -134,16 +134,30 @@ The following configuration options are available. The defaults were chosen for
 | jpeg_optimization               | see below      | see below               | Hash of options to pass to active storage when optimizing a JPEG. |
 | png_optimization                | see below      | see below               | Hash of options to pass to active storage when optimizing a PNG. |
 | active_storage_route            | `:inherited`   | `:inherited`            | Defines how urls of active storage images will be generated. If `inherited` it will use the same as active storage. Other valid options are `redirect`, `proxy` and `public`. Whatever is set here can be overriden in the helper. |
+| domains                         | empty          | -                       | Limits the domains that vitals image source can be created from |
 
+Minimagick
 ```ruby
 # jpeg_conversion
-{ sampling_factor: "4:2:0", strip: true, interlace: "JPEG", colorspace: "sRGB", quality: 85, format: "jpg", background: :white, flatten: true, alpha: :off }
+{ saver: { strip: true, quality: 85, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB", background: :white, flatten: true, alpha: :off }, format: "jpg" }
 
 # jpeg_optimization:
-{ sampling_factor: "4:2:0", strip: true, interlace: "JPEG", colorspace: "sRGB", quality: 85 }
+{ saver: { strip: true, quality: 85, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB" } }
 
 # png_optimization:
-{ strip: true, quality: 00 }
+{ saver: { strip: true, quality: 00 } }
+```
+
+Vips
+```ruby
+# jpeg_conversion
+{ saver: { strip: true, quality: 85, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3, background: 255 }, format: "jpg" }
+
+# jpeg_optimization:
+{ saver: { strip: true, quality: 85, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3 } }
+
+# png_optimization:
+{ saver: { strip: true, compression: 9 } }
 ```
 
 These can be configured in your environment files, just like any other rails settings:
@@ -151,8 +165,6 @@ These can be configured in your environment files, just like any other rails set
 ```
 Rails.application.configure do |config|
   config.vitals_image.image_library = :vips
-  config.vitals_image.mobile_width = 410
-  config.vitals_image.desktop_width = 1264
   config.vitals_image.lazy_loading = :lozad
   config.vitals_image.require_alt_attribute = true
   config.vitals_image.check_for_white_background = true

data/app/helpers/vitals_image/tag_helper.rb

@@ -6,32 +6,17 @@ module VitalsImage
       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)
+      if optimizer.non_native_lazy_load?
         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
+      else
+        url = vitals_image_url(optimizer.src, optimizer.html_options)
+        image_tag url, optimizer.html_options
       end
+    end
 
+    private
       def vitals_image_url(source, options)
         active_storage_route = options.delete("active_storage_route") || VitalsImage.active_storage_route
 

data/app/models/vitals_image/source.rb

@@ -2,8 +2,8 @@
 
 module VitalsImage
   class Source < ActiveRecord::Base
-    store :metadata, accessors: [ :analyzed, :width, :height ], coder: ActiveRecord::Coders::JSON, default: "{ analyzed: false }"
+    store :metadata, accessors: [ :identified, :analyzed, :width, :height ], coder: ActiveRecord::Coders::JSON
 
-    after_create -> { AnalyzeJob.perform_later(self) }
+    after_create_commit -> { AnalyzeJob.perform_later(self) }
   end
 end

data/db/migrate/20210809171706_add_fingerprint_to_vitals_image_sources.rb

@@ -0,0 +1,6 @@
+class AddFingerprintToVitalsImageSources < ActiveRecord::Migration[6.1]
+  def change
+    add_column :vitals_image_sources, :fingerprint, :string
+    add_index :vitals_image_sources, :fingerprint, unique: true
+  end
+end

data/lib/vitals_image.rb

@@ -14,8 +14,6 @@ module VitalsImage
   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
@@ -28,6 +26,7 @@ module VitalsImage
   mattr_accessor :jpeg_optimization
   mattr_accessor :png_optimization
   mattr_accessor :active_storage_route
+  mattr_accessor :domains
 
   mattr_accessor :skip_ssl_verification
 end

data/lib/vitals_image/cache.rb

@@ -15,7 +15,7 @@ module VitalsImage
         source = @store.read(key)
 
         if source.blank?
-          source = Source.find_or_create_by(key: key)
+          source = find_or_create_by(key)
           expires_in = source.analyzed ? nil : 1.minute
           @store.write(key, source, expires_in: expires_in)
         end
@@ -25,6 +25,16 @@ module VitalsImage
     end
 
     private
+      def find_or_create_by(key)
+        uri = URI.parse(key)
+
+        if VitalsImage.domains.present? && !VitalsImage.domains.include?(uri.host)
+          Source.new(key: key, metadata: { identified: false })
+        else
+          Source.find_or_create_by(key: key) { |source| source.identified = true }
+        end
+      end
+
       def with_retry
         yield
       rescue ActiveRecord::RecordNotUnique

data/lib/vitals_image/engine.rb

@@ -19,15 +19,17 @@ require "vitals_image/errors"
 require "vitals_image/optimizer"
 require "vitals_image/optimizer/blank"
 require "vitals_image/optimizer/url"
-require "vitals_image/optimizer/active_storage"
+require "vitals_image/optimizer/variable"
+require "vitals_image/optimizer/invariable"
 
 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.optimizers                      = [VitalsImage::Optimizer::Blank, VitalsImage::Optimizer::Variable, VitalsImage::Optimizer::Invariable, VitalsImage::Optimizer::Url]
     config.vitals_image.analyzers                       = [VitalsImage::Analyzer::UrlAnalyzer]
+    config.vitals_image.domains                         = []
 
     config.eager_load_namespaces << VitalsImage
 
@@ -39,8 +41,6 @@ module VitalsImage
         VitalsImage.optimizers                 = app.config.vitals_image.optimizers                 || []
         VitalsImage.analyzers                  = app.config.vitals_image.analyzers                  || []
 
-        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
@@ -53,6 +53,7 @@ module VitalsImage
         VitalsImage.jpeg_conversion            = app.config.vitals_image.jpeg_conversion
         VitalsImage.jpeg_optimization          = app.config.vitals_image.jpeg_optimization
         VitalsImage.png_optimization           = app.config.vitals_image.png_optimization
+        VitalsImage.domains                    = app.config.vitals_image.domains                    || []
 
         VitalsImage.skip_ssl_verification      = app.config.vitals_image.skip_ssl_verification      || false
       end
@@ -69,13 +70,13 @@ module VitalsImage
     initializer "vitals_image.optimizations" do
       config.after_initialize do |app|
         if VitalsImage.image_library == :vips
-          VitalsImage.jpeg_conversion   ||= { saver: { strip: true, quality: 85, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3, background: 255 }, format: "jpg" }
-          VitalsImage.jpeg_optimization ||= { saver: { strip: true, quality: 85, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3 } }
+          VitalsImage.jpeg_conversion   ||= { saver: { strip: true, quality: 80, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3, background: 255 }, format: "jpg" }
+          VitalsImage.jpeg_optimization ||= { saver: { strip: true, quality: 80, interlace: true, optimize_coding: true, trellis_quant: true, quant_table: 3 } }
           VitalsImage.png_optimization  ||= { saver: { strip: true, compression: 9 } }
         else
-          VitalsImage.jpeg_conversion   ||= { saver: { strip: true, quality: 85, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB", background: :white, flatten: true, alpha: :off }, format: "jpg" }
-          VitalsImage.jpeg_optimization ||= { saver: { strip: true, quality: 85, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB" } }
-          VitalsImage.png_optimization  ||= { saver: { strip: true, quality: 00 } }
+          VitalsImage.jpeg_conversion   ||= { saver: { strip: true, quality: 80, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB", background: :white, flatten: true, alpha: :off }, format: "jpg" }
+          VitalsImage.jpeg_optimization ||= { saver: { strip: true, quality: 80, interlace: "JPEG", sampling_factor: "4:2:0", colorspace: "sRGB" } }
+          VitalsImage.png_optimization  ||= { saver: { strip: true, quality: 75 } }
         end
       end
     end

data/lib/vitals_image/gem_version.rb

@@ -8,7 +8,7 @@ module VitalsImage
 
   module VERSION
     MAJOR = 0
-    MINOR = 2
+    MINOR = 5
     TINY  = 0
     PRE   = nil
 

data/lib/vitals_image/optimizer.rb

@@ -26,10 +26,10 @@ module VitalsImage
 
     def html_options
       @html_options ||= begin
-        html_options = @options.dup
+        html_options = @options.dup.except("lazy_load")
         html_options["width"]           = width
         html_options["height"]          = height
-        html_options["style"]           = style
+        html_options["style"]           = "#{style} #{html_options["style"]}".squish.presence
         html_options["class"]           = "vitals-image #{html_options["class"]}".squish
 
         if non_native_lazy_load?
@@ -57,11 +57,6 @@ module VitalsImage
       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

data/lib/vitals_image/optimizer/invariable.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module VitalsImage
+  class Optimizer::Invariable < Optimizer
+    def self.accept?(source)
+      source.respond_to?(:variable?) && !source.variable?
+    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 original_width
+        metadata[:width]
+      end
+
+      def original_height
+        metadata[:height]
+      end
+
+      def metadata
+        @source.metadata
+      end
+
+      def analyzed?
+        metadata[:analyzed]
+      end
+  end
+end

data/lib/vitals_image/optimizer/url.rb

@@ -17,7 +17,7 @@ module VitalsImage
       end
 
       def style
-        if !analyzed?
+        if !identified? || !analyzed?
           # Do nothing
         elsif !requested_height
           "height:auto;"
@@ -26,6 +26,10 @@ module VitalsImage
         end
       end
 
+      def identified?
+        metadata.identified
+      end
+
       def analyzed?
         metadata.analyzed
       end

data/lib/vitals_image/optimizer/{active_storage.rb → variable.rb}

@@ -1,13 +1,9 @@
 # frozen_string_literal: true
 
 module VitalsImage
-  class Optimizer::ActiveStorage < Optimizer
+  class Optimizer::Variable < Optimizer
     def self.accept?(source)
-      source.is_a?(::ActiveStorage::Attached) || source.is_a?(::ActiveStorage::Attachment) || source.is_a?(::ActiveStorage::Blob)
-    end
-
-    def variable?
-      true
+      source.respond_to?(:variable?) && source.variable?
     end
 
     private
@@ -65,31 +61,31 @@ module VitalsImage
       end
 
       def optimize_jpeg
-        @source.variant optimizations_with_optimal_quality(VitalsImage.jpeg_optimization)
+        @source.variant resize_and_flatten(VitalsImage.jpeg_optimization)
       end
 
       def optimize_png
         if alpha? || !VitalsImage.convert_to_jpeg
-          @source.variant optimizations(VitalsImage.png_optimization)
+          @source.variant resize(VitalsImage.png_optimization)
         else
-          @source.variant optimizations_with_optimal_quality(VitalsImage.jpeg_conversion)
+          @source.variant resize_and_flatten(VitalsImage.jpeg_conversion)
         end
       end
 
       def optimize_generic
         if alpha? || !VitalsImage.convert_to_jpeg
-          @source.variant optimizations
+          @source.variant resize
         else
-          @source.variant optimizations_with_optimal_quality(VitalsImage.jpeg_conversion)
+          @source.variant resize_and_flatten(VitalsImage.jpeg_conversion)
         end
       end
 
-      def optimizations_with_optimal_quality(defaults = {})
-        quality = @source.metadata[:optimal_quality] || defaults[:saver][:quality]
-        defaults.merge quality: quality, "#{resize_mode}": dimensions
+      def resize_and_flatten(defaults = {})
+        resize  = resize_mode != :resize_and_pad ? dimensions : dimensions.push(background: [255])
+        defaults.merge "#{resize_mode}": resize
       end
 
-      def optimizations(defaults = {})
+      def resize(defaults = {})
         defaults.merge "#{resize_mode}": dimensions
       end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vitals_image
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Breno Gazzola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -243,6 +243,7 @@ files:
 - app/views/layouts/vitals_image/application.html.erb
 - config/routes.rb
 - db/migrate/20210502132155_create_vitals_image_sources.rb
+- db/migrate/20210809171706_add_fingerprint_to_vitals_image_sources.rb
 - lib/tasks/vitals_image_tasks.rake
 - lib/vitals_image.rb
 - lib/vitals_image/analyzer.rb
@@ -253,9 +254,10 @@ files:
 - 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/invariable.rb
 - lib/vitals_image/optimizer/url.rb
+- lib/vitals_image/optimizer/variable.rb
 - lib/vitals_image/test_case.rb
 - lib/vitals_image/version.rb
 homepage: https://github.com/FestaLab/vitals_image