active_analysis 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 682b39ef90eab2d2f825bb31f75b2345e32a4df0858d063f1f13314fd1aa25e6
-  data.tar.gz: c5cb58d2b1ac0304fc220953b4cf7250e4568642b1be30017bf56caf71b2fea1
+  metadata.gz: 44cf23f9065e97caa7532489c6aa8f2ad0eb14c8cd9a6bfa5c632fbcb83b90cf
+  data.tar.gz: 84402156bf4c055d70ef121692cc0e0ac415a5d0cfa6ed91be31bacb410e7a4a
 SHA512:
-  metadata.gz: '0860684f890ee8b3c1818ef547126de464c1b3a2434e70850dbcd3d57fddb087c478412753936a58608700564197bdaff7ed0951fceba4b6a4bb6b2eb0ad0135'
-  data.tar.gz: f1eba05f7f54af13851000862d7c45d99e04a44ce511dfe2e815b2a1539df5f64a10df1d812a98fbbeb6f10c350dd3354f1c870c993e92754ed6326b415d6830
+  metadata.gz: ab5fcbe11d109a5e772522cd7f02d1482ca847b3b2b0aad5f005c0db46eee2b37811a689bf0b93131e7cb5910b7f1848f7179b054fc596ec4b2665d5baa1cad6
+  data.tar.gz: f7d992056c9bb40ec9dca2bb6d4816695c6c24fc9413eb10266cbe3db266abfa12866deeb3d4178c2dad6e21209ec8dac766fb204514fde19e939adbc4df88b8

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
-## [0.1.0] - 2021-05-01
+## [0.2] - 2021-05-01
+
+- Added `opaque` metadata value to images
+
+## [0.1.3] - 2021-05-01
 
 - Initial release

data/README.md

@@ -18,11 +18,50 @@ 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)
 
 ## Development
 

data/lib/active_analysis.rb

@@ -7,6 +7,9 @@ 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
 end

data/lib/active_analysis/analyzer/image_analyzer.rb

@@ -9,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)
@@ -19,12 +19,25 @@ 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) }
         else
-          { width: image.width, height: image.height }
+          { width: image.width, height: image.height, opaque: opaque?(image) }
         end
       end
     end
+
+    private
+      def read_image
+        raise NotImplementedError
+      end
+
+      def rotated_image?(image)
+        raise NotImplementedError
+      end
+
+      def opaque?(image)
+        raise NotImplementedError
+      end
   end
 end
 

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

@@ -7,7 +7,7 @@ module ActiveAnalysis
   # 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
@@ -34,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"]["min"] == value
+      end
   end
 end
 

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

@@ -7,14 +7,14 @@ module ActiveAnalysis
   # 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
@@ -39,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
@@ -47,4 +52,3 @@ module ActiveAnalysis
       end
   end
 end
-

data/lib/active_analysis/analyzer/pdf_analyzer.rb

@@ -7,7 +7,7 @@ module ActiveAnalysis
   #
   # 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/engine.rb

@@ -18,27 +18,41 @@ module ActiveAnalysis
   class Engine < ::Rails::Engine
     isolate_namespace ActiveAnalysis
 
-    config.active_analysis                             = ActiveSupport::OrderedOptions.new
+    config.active_analysis = ActiveSupport::OrderedOptions.new
     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
+        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
       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  = 3
+    MINOR = 2
+    TINY  = 0
     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.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Breno Gazzola
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2021-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage
@@ -16,28 +16,28 @@ 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
   requirement: !ruby/object:Gem::Requirement
@@ -219,7 +219,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