imogen 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09124ca98f369b44498c5605caa4f45dd5d8225b3416fb2bc4d90e7224a0fda2'
-  data.tar.gz: e7e7b386740002d47365e5e1f1838c9328184982bcd90ca081405bf7f615bc6d
+  metadata.gz: ea96ea6896a683acb44ea5e961a1f0b6b5584b2b12046b9fcc02f8a0de1094fa
+  data.tar.gz: 52d98cea18de1c25645285f1e5a5ee6c39296ce2327215a972138a0a32fefca9
 SHA512:
-  metadata.gz: fddb3b745f8cca9c19e13e58f8d70f520e02a7319f4a46a4191497e47f70f1c5216ce500fe8e95a93b64207a83f1aaa15a889b67a0da507396143fef5aafef4f
-  data.tar.gz: 67be3ab83b6823be1b662896085cc896a42c104bd99ea17d0f861dc1f1c1aa538e951fbc6f2aa2f2e13cbcc318d9defc2174bd8abae72d286b24b01261efb82f
+  metadata.gz: 66026e6285cb28981400f001c6ecc78ecf2e2cfe62f664d7a1fd911b37ce298c2ca49fb9643ade651c2d21815a5b475a557bd4b2670c42e18d7b13af9f65ce26
+  data.tar.gz: ba2f95151b23693d2c16887c59baa5be9ee2554c9b875d6d9def3e37858e2ffee36b30e996d3e98eb0124fe662acb33dd83979e231a63400907a6543ae58510d

data/lib/imogen.rb

@@ -1,6 +1,16 @@
 # encoding: UTF-8
 require 'vips'
+require 'ffi'
+
 module Imogen
+  extend FFI::Library
+
+  # Note: library_name function comes from `require 'vips'`
+  ffi_lib library_name("vips", 42)
+
+  attach_function :vips_cache_get_max_mem, [], :int
+  attach_function :vips_cache_set_max_mem, [:int], :void
+  attach_function :vips_tracked_get_mem, [], :int
 
   def self.from(src_path)
     yield Vips::Image.matload(src_path)
@@ -26,10 +36,36 @@ module Imogen
     raise "format from path not implemented"
   end
 
-  def self.image(src_path, flags=0)
+  # @param [String] src_path The local file path to the image.
+  # @param [Hash] opts The options to use when opening an image.
+  # @option opts [Boolean] :nocache When true, will clear the Vips cache before opening the image.
+  def self.image(src_path, opts = {})
+    # TODO: Change to `new_from_file(src_path, {nocache: nocache})`, or something similar,
+    # when these two GitHub issues are addressed:
+    # 1) https://github.com/libvips/ruby-vips/issues/360
+    # 2) https://github.com/libvips/libvips/pull/3370
+    clear_vips_cache_mem if opts[:nocache] == true
     Vips::Image.new_from_file(src_path)
   end
-  def self.with_image(src_path, flags = 0, &block)
-    block.yield(image(src_path, flags))
+
+  # @param [String] src_path The local file path to the image.
+  # @param [Hash] opts The options to use when opening an image.
+  # @option opts [Boolean] :nocache When true, will clear the Vips cache before opening the image.
+  def self.with_image(src_path, opts = {}, &block)
+    block.yield(image(src_path, opts))
+  end
+
+  # TODO: The clear_vips_cache_mem method can be removed once these two tickets are addressed:
+  # 1) https://github.com/libvips/ruby-vips/issues/360
+  # 2) https://github.com/libvips/libvips/pull/3370
+  def self.clear_vips_cache_mem
+    # store original max because we'll restore it later
+    original_max_value = vips_cache_get_max_mem
+
+    # Drop max mem to 0, which also internally triggers a trim operation that clears out old cache entries
+    vips_cache_set_max_mem(0)
+
+    # Restore original value to support future caching operations
+    vips_cache_set_max_mem(original_max_value)
   end
 end

data/spec/integration/imogen_spec.rb

@@ -0,0 +1,25 @@
+require 'imogen'
+require 'tmpdir'
+
+describe Imogen, vips: true do
+  describe ".with_image" do
+    it 'should call clear_vips_cache_mem when nocache option is provided' do
+      expect(Vips::Image).to receive(:new_from_file)
+      expect(Imogen).to receive(:clear_vips_cache_mem)
+      Imogen.with_image(fixture('sample.jpg').path, nocache: true) do |img|
+        # don't need to do anything with the image for this test
+      end
+    end
+
+    it 'should not call clear_vips_cache_mem when nocache option is not provided, or is false' do
+      expect(Vips::Image).to receive(:new_from_file).twice
+      expect(Imogen).not_to receive(:clear_vips_cache_mem)
+      Imogen.with_image(fixture('sample.jpg').path, nocache: false) do |img|
+        # don't need to do anything with the image for this test
+      end
+      Imogen.with_image(fixture('sample.jpg').path) do |img|
+        # don't need to do anything with the image for this test
+      end
+    end
+  end
+end

data/spec/integration/transparent_image_conversion_spec.rb

@@ -0,0 +1,62 @@
+require 'imogen'
+require 'tmpdir'
+
+describe 'Transparent image conversion', vips: true do
+  let(:output_file) { Dir.tmpdir + '/test-imogen-convert.jpg' }
+  let(:vips_image_double) do
+    dbl = double(Vips::Image)
+    allow(dbl).to receive(:height).and_return(1080)
+    allow(dbl).to receive(:width).and_return(1920)
+    dbl
+  end
+
+  describe 'Imogen::Iiif.convert' do
+    it "should convert transparent pixels to white pixels when converting to a raster type that does not support transparency" do
+      Imogen.with_image(fixture('sample-with-transparency.png').path) do |img|
+        expect(img.getpoint(0, 0)).to eq([255, 255, 255, 0.0])
+        Imogen::Iiif.convert(img, output_file, 'jpg', region: 'full', size: 'full', quality: 'color', rotation: '0')
+      end
+
+      Imogen.with_image(output_file) do |img|
+        expect(img.getpoint(0, 0)).to eq([255, 255, 255])
+      end
+    ensure
+      File.delete(output_file) if File.exist?(output_file)
+    end
+
+    it "should pass the expected background parameter when calling write_to_file" do
+      expect(Imogen).to receive(:with_image).and_yield(vips_image_double)
+      expect(vips_image_double).to receive(:write_to_file).with(String, {background: [255, 255, 255]})
+      Imogen.with_image(fixture('sample.jpg').path) do |img|
+        Imogen::Iiif.convert(img, output_file, 'jpg', region: 'full', size: 'full', quality: 'color', rotation: '0')
+      end
+    end
+  end
+
+  describe 'Imogen::AutoCrop.convert' do
+    # Note: The test below is reliable because the input image is square, but it might fail if the
+    # fixture image is ever changed, since a non-square image may have an unpredictable
+    # auto-detected, featured, square region.  This is fine though, since in this case we're only
+    # testing transparent pixel conversion and not testing cropping behavior.
+    it "should convert transparent pixels to white pixels when converting to a raster type that does not support transparency" do
+      Imogen.with_image(fixture('sample-with-transparency.png').path) do |img|
+        expect(img.getpoint(0, 0)).to eq([255, 255, 255, 0.0])
+        Imogen::AutoCrop.convert(img, output_file, 500)
+      end
+
+      Imogen.with_image(output_file) do |img|
+        expect(img.getpoint(0, 0)).to eq([255, 255, 255])
+      end
+    ensure
+      File.delete(output_file) if File.exist?(output_file)
+    end
+
+    it "should pass the expected background parameter when calling write_to_file" do
+      allow(Imogen::Iiif::Region::Featured).to receive(:convert).and_yield(vips_image_double)
+      expect(vips_image_double).to receive(:write_to_file).with(String, {background: [255, 255, 255]})
+      Imogen.with_image(fixture('sample.jpg').path) do |img|
+        Imogen::AutoCrop.convert(img, output_file, 500)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imogen
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ben Armintor
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-vips
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
 description:
 email: armintor@gmail.com
 executables: []
@@ -69,9 +69,12 @@ files:
 - lib/imogen/iiif/tiles.rb
 - lib/imogen/zoomable.rb
 - lib/imogencv.bundle
+- spec/fixtures/files/sample-with-transparency.png
 - spec/fixtures/files/sample.jpg
 - spec/integration/imogen_autocrop_spec.rb
 - spec/integration/imogen_iiif_spec.rb
+- spec/integration/imogen_spec.rb
+- spec/integration/transparent_image_conversion_spec.rb
 - spec/spec_helper.rb
 - spec/unit/imogen_iiif_quality_spec.rb
 - spec/unit/imogen_iiif_region_spec.rb
@@ -96,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: IIIF image derivative generation helpers for Vips