active_analysis 0.1.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2264c818bb6bbdf31ecde9797cbeb77edf1f42b52d3b7f3f0178fbf47fec2ef8
-  data.tar.gz: 8cf368194ab3226945d275fea222685b346c6c6821dddde0ad9ddcdea40ca445
+  metadata.gz: d9bd54c9d6b6579f5419244bdce0170c10889efc633d363b2a9be8129335b0bf
+  data.tar.gz: bea8aa7a1e0f5c8d716c6d9eb2c3d253f5a1be3cb461484c16b5e281f47cd6bd
 SHA512:
-  metadata.gz: e9381a23b549ef234a7d4e13aa04460b99d6365b1f82f6cd3359d8d4b31e72d7be3664ee64536ff73429353c83122f5a0f113b64ebd104c530f1721cb1ed363e
-  data.tar.gz: c9f3f4ce840c7b1cfae253459f09af28163672fff60c1d0643f45f256d3b08d4689752de359d47923e883c1e43abb9a6e33a91c8089ea27a26b7e95a72dc5710
+  metadata.gz: 402b15df181ac8bc2f583e70d9f856d7b7a9271493883a5ee9b7998aa890cb15c771f68e5be12028b4bfca29bf2514886fd09d841106cba88bed50975067dedb
+  data.tar.gz: f35aa5ac09d2f3294512541733f38d5fa649c82994c685d26d92f9dd94f6f6e15a83fda66affae7553b7028fb1878542586242d524124f8afa6a8d226052e52a

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-05-01
+## [0.3] - 2021-06-17
+
+- Added addons feature
+
+## [0.2] - 2021-06-01
+
+- Added `opaque` metadata value to images
+
+## [0.1.3] - 2021-05-01
 
 - Initial release

data/README.md

@@ -18,11 +18,62 @@ And then execute:
 
 ## Usage
 
-Active Analyzers will automatically add all its analyzers to Active Storage's analyzers array. Don't worry, if you added any custom analyzers they will be there. You can check the comments in the source code of each analyzer to see what information they extract from files:
-- Audio: [source](https://github.com/FestaLab/active_analysis/blob/main/lib/active_analysis/analyzer/audio_analyzer.rb)
-- Image: [source](https://github.com/FestaLab/active_analysis/blob/main/lib/active_analysis/analyzer/image_analyzer.rb)
-- PDF: [source](https://github.com/FestaLab/active_analysis/blob/main/lib/active_analysis/analyzer/pdf_analyzer.rb)
-- Video: [source](https://github.com/FestaLab/active_analysis/blob/main/lib/active_analysis/analyzer/video_analyzer.rb)
+Active Analysis automatically replaces all of Rails default analyzers with its own. It will not remove other custom analyzers if you have them. You can also configure which analyzers will be inserted.
+
+```ruby
+Rails.application.configure do |config|
+  config.active_analysis.image_library  = :vips # Defaults to the same as active storage
+  config.active_analysis.image_analyzer = true  # Defaults to true
+  config.active_analysis.audio_analyzer = true  # Defaults to true
+  config.active_analysis.pdf_analyzer   = false # Defaults to true
+  config.active_analysis.video_analyzer = false # Defaults to true
+end
+```
+
+#### Image
+A modification of the original image analyzer and a new analyzer. Requires the [ImageMagick](http://www.imagemagick.org) system library or the [libvips](https://github.com/libvips/libvips) system library.
+
+- Width (pixels)
+- Height (pixels)
+- Opaque (true if file is opaque, false if not)
+
+An image will be considered opaque if it does not have an alpha channel, or if none of its pixels have an alpha value below the minimum (as defined by the library).
+
+#### PDF
+A new analyzer. Requires the [poppler](https://poppler.freedesktop.org/) system library.
+
+- Width (pixels)
+- Height (pixels)
+- Pages
+
+#### Audio
+A new analyzer. Requires the [FFmpeg](https://www.ffmpeg.org) system library.
+
+- Duration (seconds)
+- Bit Rate (bits/second)
+
+#### Video
+A modification of the original video analyzer. Requires the [FFmpeg](https://www.ffmpeg.org) system library
+
+- Width (pixels)
+- Height (pixels)
+- Duration (seconds)
+- Angle (degrees)
+- Display aspect ratio
+- Audio (true if file has an audio channel, false if not)
+- Video (true if file has an video channel, false if not)
+
+## Addons
+Active Analysis allows additional features to be added to the image analyzers through addons. To create an addon simply inherit the `Addon` class and add it to the addons array in the configuration.
+```ruby
+Rails.application.configure do |config|
+  config.active_analysis.addons << ActiveAnalysis::Addon::ImageAddon::OptimalQuality
+end
+```
+
+The following addons available:
+- ImageAddon::OptimalQuality: An EXPERIMENTAL addon that calculates the optimal image quality using a DSSIM of 0.001. This addon is SLOOOOOOW.
+- ImageAddon::WhiteBackground: An EXPERIMENTAL addon that checks if the image has a white background. Requires both vips and image magick to be installed.
 
 ## Development
 

data/lib/active_analysis.rb

@@ -7,6 +7,12 @@ module ActiveAnalysis
   autoload :FixtureSet
 
   mattr_accessor :logger
-  mattr_accessor :analyzers
+
   mattr_accessor :image_library
+  mattr_accessor :image_analyzer
+  mattr_accessor :audio_analyzer
+  mattr_accessor :pdf_analyzer
+  mattr_accessor :video_analyzer
+
+  mattr_accessor :addons
 end

data/lib/active_analysis/addon.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ActiveAnalysis
+  # This is an abstract base class for analyzer addons, which extract extra metadata from blobs.
+  class Addon
+    attr_reader :file
+
+    def self.accept?(blob)
+      false
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def metadata
+      raise NotImplementedError
+    end
+  end
+end

data/lib/active_analysis/addon/image_addon.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "../addon"
+
+module ActiveAnalysis
+  # This is an abstract base class for image addons
+  class Addon::ImageAddon < Addon
+    def self.accept?(blob)
+      blob.image?
+    end
+
+    def metadata
+      raise NotImplementedError
+    end
+  end
+end
+

data/lib/active_analysis/addon/image_addon/optimal_quality.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "../image_addon"
+
+module ActiveAnalysis
+  class Addon::ImageAddon::OptimalQuality < Addon::ImageAddon
+    def metadata
+      { optimal_quality: calculate_optimal_quality }
+    end
+
+    private
+      def calculate_optimal_quality
+        quality = 85
+
+        loop do
+          new_quality = quality - 5
+          dssim = calculate_dssim(new_quality)
+          break if dssim > 0.001 || quality < 55
+          quality = new_quality
+        end
+
+        quality
+      rescue
+        nil
+      end
+
+      def calculate_dssim(quality)
+        image_with_quality(quality) do |image|
+          dssim = `dssim #{filepath} #{image.path}`
+          Float dssim.split.first
+        end
+      end
+
+      def image_with_quality(quality)
+        extname  = File.extname(filepath)
+        basename = File.basename(filepath, extname)
+
+        Tempfile.create(["#{basename}_#{quality}", extname]) do |tempfile|
+          processor.apply(saver: { format: "jpg", quality: quality }).call(filepath, destination: tempfile.path)
+          yield tempfile
+        end
+      end
+
+      def filepath
+        ActiveAnalysis.image_library == :vips ? file.filename : file.path
+      end
+
+      def processor
+        ActiveAnalysis.image_library == :vips ? ::ImageProcessing::Vips : ::ImageProcessing::MiniMagick
+      end
+  end
+end

data/lib/active_analysis/addon/image_addon/white_background.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "../image_addon"
+
+module ActiveAnalysis
+  class Addon::ImageAddon::WhiteBackground < Addon::ImageAddon
+    def metadata
+      { white_background: white_background? }
+    end
+
+    private
+      def white_background?
+        corners = extract_corner_areas(file)
+        colors = corners.map { |corner| primary_color_for(corner) }
+        colors.all? { |color| color.all? { |value| value > 250 } }
+      rescue
+        nil
+      end
+
+      def extract_corner_areas(image)
+        paths = []
+
+        image_path = ActiveAnalysis.image_analyzer == :vips ? image.filename : image.path
+        basename   = SecureRandom.urlsafe_base64
+        width      = image.width
+        height     = image.height
+        size       = 8
+
+        paths << Rails.root.join("tmp", "#{basename}_top_left.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} 0 0 #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_top_right.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} #{width - size} 0 #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_bottom_right.jpg")
+        `vips im_extract_area #{image_path} #{paths.last} #{width - size} #{height - size} #{size} #{size}`
+
+        paths << Rails.root.join("tmp", "#{basename}_bottom_left.jpg")
+        `vips im_extract_area #{image_path} #{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
+

data/lib/active_analysis/analyzer/audio_analyzer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../analyzer"
+
 module ActiveAnalysis
   # Extracts duration (seconds) and bit_rate (bits/s) from an audio blob.
   #

data/lib/active_analysis/analyzer/image_analyzer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../analyzer"
+
 module ActiveAnalysis
   # This is an abstract base class for image analyzers, which extract width and height from an image blob.
   #
@@ -7,7 +9,7 @@ module ActiveAnalysis
   #
   # Example:
   #
-  #   ActiveAnalysis::CoreExtensionsAnalyzer::ImageAnalyzer::ImageMagick.new(blob).metadata
+  #   ActiveAnalysis::Analyzer::ImageAnalyzer::ImageMagick.new(blob).metadata
   #   # => { width: 4104, height: 2736 }
   class Analyzer::ImageAnalyzer < Analyzer
     def self.accept?(blob)
@@ -17,12 +19,29 @@ module ActiveAnalysis
     def metadata
       read_image do |image|
         if rotated_image?(image)
-          { width: image.height, height: image.width }
+          { width: image.height, height: image.width, opaque: opaque?(image), **addons(image) }.compact
         else
-          { width: image.width, height: image.height }
+          { width: image.width, height: image.height, opaque: opaque?(image), **addons(image) }.compact
         end
       end
     end
+
+    private
+      def read_image
+        raise NotImplementedError
+      end
+
+      def rotated_image?(image)
+        raise NotImplementedError
+      end
+
+      def opaque?(image)
+        raise NotImplementedError
+      end
+
+      def addons(image)
+        ActiveAnalysis.addons.select { |addon| addon.accept?(blob) }.map { |addon_class| addon_class.new(image).metadata }.reduce({}, :merge).compact
+      end
   end
 end
 

data/lib/active_analysis/analyzer/image_analyzer/image_magick.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "../image_analyzer"
+
 module ActiveAnalysis
   # This analyzer relies on the third-party {MiniMagick}[https://github.com/minimagick/minimagick] gem. MiniMagick requires
   # the {ImageMagick}[http://www.imagemagick.org] system library.
   class Analyzer::ImageAnalyzer::ImageMagick < Analyzer::ImageAnalyzer
     def self.accept?(blob)
-      super && ActiveStorage.variant_processor == :mini_magick
+      super && ActiveAnalysis.image_library == :mini_magick
     end
 
     private
@@ -32,6 +34,13 @@ module ActiveAnalysis
       def rotated_image?(image)
         %w[ RightTop LeftBottom TopRight BottomLeft ].include?(image["%[orientation]"])
       end
+
+      def opaque?(image)
+        return true unless image.data["channelDepth"].key?("alpha")
+
+        value = image.data["version"] =~ /7.\d/ ? 255 : 0
+        image.data["channelStatistics"]["alpha"]["mean"] == value
+      end
   end
 end
 

data/lib/active_analysis/analyzer/image_analyzer/vips.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
+require_relative "../image_analyzer"
+
 module ActiveAnalysis
   # This analyzer relies on the third-party {ruby-vips}[https://github.com/libvips/ruby-vips] gem. Ruby-vips requires
   # the {libvips}[https://libvips.github.io/libvips/] system library.
   class Analyzer::ImageAnalyzer::Vips < Analyzer::ImageAnalyzer
     def self.accept?(blob)
-      super && ActiveStorage.variant_processor == :vips
+      super && ActiveAnalysis.image_library == :vips
     end
 
     private
       def read_image
         download_blob_to_tempfile do |file|
           require "ruby-vips"
-          image = ::Vips::Image.new_from_file(file.path, access: :sequential)
+          image = ::Vips::Image.new_from_file(file.path)
 
           if valid_image?(image)
             yield image
@@ -37,6 +39,11 @@ module ActiveAnalysis
         false
       end
 
+      def opaque?(image)
+        return true unless image.has_alpha?
+        image[image.bands - 1].min == 255
+      end
+
       def valid_image?(image)
         image.avg
         true
@@ -45,4 +52,3 @@ module ActiveAnalysis
       end
   end
 end
-

data/lib/active_analysis/analyzer/pdf_analyzer.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "../analyzer"
+
 module ActiveAnalysis
   # Extracts width, height in pixels and number of pages from a pdf blob.
   #
   # Example:
   #
-  #   ActiveAnalysis::CoreExtensionsAnalyzer::PDFAnalyzer::Poppler.new(blob).metadata
+  #   ActiveAnalysis::Analyzer::PDFAnalyzer::Poppler.new(blob).metadata
   #   # => { width: 4104, height: 2736, pages: 10 }
   #
   # This analyzer requires the {poppler}[https://poppler.freedesktop.org/] system library, which is not provided by Rails.

data/lib/active_analysis/analyzer/video_analyzer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../analyzer"
+
 module ActiveAnalysis
   # Extracts the following from a video blob:
   #

data/lib/active_analysis/engine.rb

@@ -3,6 +3,7 @@
 require "active_storage"
 
 require "marcel"
+require "image_processing"
 require "ruby-vips"
 require "mini_magick"
 
@@ -14,31 +15,54 @@ require_relative "analyzer/audio_analyzer"
 require_relative "analyzer/video_analyzer"
 require_relative "analyzer/pdf_analyzer"
 
+require_relative "addon"
+require_relative "addon/image_addon"
+require_relative "addon/image_addon/optimal_quality"
+require_relative "addon/image_addon/white_background"
+
 module ActiveAnalysis
   class Engine < ::Rails::Engine
     isolate_namespace ActiveAnalysis
 
-    config.active_analysis                             = ActiveSupport::OrderedOptions.new
+    config.active_analysis = ActiveSupport::OrderedOptions.new
+    config.active_analysis.addons = []
+
     config.eager_load_namespaces << ActiveAnalysis
 
     initializer "active_analysis.configs" do
       config.after_initialize do |app|
-        ActiveAnalysis.logger                          = app.config.active_analysis.logger || Rails.logger
-        ActiveAnalysis.analyzers                       = app.config.active_analysis.analyzers || []
-        ActiveAnalysis.image_library                   = app.config.active_analysis.image_library || app.config.active_storage.variant_processor
+        ActiveAnalysis.logger         = app.config.active_analysis.logger         || Rails.logger
+
+        ActiveAnalysis.image_library  = app.config.active_analysis.image_library  || app.config.active_storage.variant_processor || :mini_magick
+        ActiveAnalysis.image_analyzer = app.config.active_analysis.image_analyzer || true
+        ActiveAnalysis.audio_analyzer = app.config.active_analysis.audio_analyzer || true
+        ActiveAnalysis.pdf_analyzer   = app.config.active_analysis.pdf_analyzer   || true
+        ActiveAnalysis.video_analyzer = app.config.active_analysis.video_analyzer || true
+        ActiveAnalysis.addons         = app.config.active_analysis.addons         || []
       end
     end
 
-    initializer "active_analysis.core_extensions" do
+    initializer "active_analysis.analyzers" do
       config.after_initialize do |app|
-        app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::ImageAnalyzer
-        app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::VideoAnalyzer
-
-        app.config.active_storage.analyzers.append Analyzer::ImageAnalyzer::Vips
-        app.config.active_storage.analyzers.append Analyzer::ImageAnalyzer::ImageMagick
-        app.config.active_storage.analyzers.append Analyzer::VideoAnalyzer
-        app.config.active_storage.analyzers.append Analyzer::AudioAnalyzer
-        app.config.active_storage.analyzers.append Analyzer::PDFAnalyzer
+        if ActiveAnalysis.image_analyzer
+          app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::ImageAnalyzer
+          app.config.active_storage.analyzers.append Analyzer::ImageAnalyzer::Vips
+          app.config.active_storage.analyzers.append Analyzer::ImageAnalyzer::ImageMagick
+        end
+
+        if ActiveAnalysis.video_analyzer
+          app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::VideoAnalyzer
+          app.config.active_storage.analyzers.append Analyzer::VideoAnalyzer
+        end
+
+        if ActiveAnalysis.audio_analyzer
+          app.config.active_storage.analyzers.delete ActiveStorage::Analyzer::ImageAnalyzer if defined?(ActiveStorage::Analyzer::ImageAnalyzer)
+          app.config.active_storage.analyzers.append Analyzer::AudioAnalyzer
+        end
+
+        if ActiveAnalysis.pdf_analyzer
+          app.config.active_storage.analyzers.append Analyzer::PDFAnalyzer
+        end
       end
     end
   end

data/lib/active_analysis/gem_version.rb

@@ -8,8 +8,8 @@ module ActiveAnalysis
 
   module VERSION
     MAJOR = 0
-    MINOR = 1
-    TINY  = 2
+    MINOR = 3
+    TINY  = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_analysis
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Breno Gazzola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -16,70 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: mini_magick
+  name: image_processing
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '1.2'
   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'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +157,10 @@ files:
 - app/views/layouts/active_analysis/application.html.erb
 - config/routes.rb
 - lib/active_analysis.rb
+- lib/active_analysis/addon.rb
+- lib/active_analysis/addon/image_addon.rb
+- lib/active_analysis/addon/image_addon/optimal_quality.rb
+- lib/active_analysis/addon/image_addon/white_background.rb
 - lib/active_analysis/analyzer.rb
 - lib/active_analysis/analyzer/audio_analyzer.rb
 - lib/active_analysis/analyzer/image_analyzer.rb
@@ -219,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: Collection of Active Storage analyzers