assembly-image 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 307844d855e2e94047191cbb357f944366345bc9d959b942a26c41ec7f0d6a3c
-  data.tar.gz: 966fcaebcf1ef6877da8a9498019b12628f6aa097cfa8b97d22e98fabbba8aac
+  metadata.gz: 46a8b192fe259bee51df21215e413dc0a570012b441f530cabb73a172dfb6e13
+  data.tar.gz: a87eb5df0582c60e74c182e8711758df11388a4aaaf9084149a0b1b3bcdaf5a7
 SHA512:
-  metadata.gz: f8c77143ffebd2651796779292d0861aaa9b41f2a7621b8e9991bdc225f297f80d970ef108fdbbd47755b5ac5b65a8f71e64b581042a240d6bc38b19bbf0d2d9
-  data.tar.gz: 9870392be2e09567d802d2b5a395feb457e7bbb8d19b1f16a4ce49bcf1cce562f66bab4920c4b5a50d0e5eff41fdae40def644e764d1ee37c3fdee8df30e17bc
+  metadata.gz: cdbb16145c19623c462b5a0121dafe614e09d6f37dfd5ca1cde1ea4b38eb3829c0cf33300dbde92f64a3c678e2c313bd5241352a52510499c084061058a2204a
+  data.tar.gz: 56d878d05722d07fbb0fe42e8ae04bdb39772ada0c94d03808ba066ef89719a0af0419ceaa667db53030b7385139226ef77a1c3d97bb8d76640f58e3e848a7c0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    assembly-image (2.1.1)
+    assembly-image (2.1.2)
       activesupport (> 6.1)
       assembly-objectfile (>= 1.6.4)
       ruby-vips (>= 2.0)

data/assembly-image.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'assembly-image'
-  s.version     = '2.1.1'
+  s.version     = '2.1.2'
   s.authors     = ['Peter Mangiafico', 'Renzo Sanchez-Silva', 'Monty Hindman', 'Tony Calavano']
   s.email       = ['pmangiafico@stanford.edu']
   s.homepage    = ''

data/lib/assembly/image/jp2_creator.rb

@@ -35,7 +35,7 @@ module Assembly
         @overwrite = overwrite
       end
 
-      attr_reader :image, :output_path, :tmp_folder, :tmp_tiff_path
+      attr_reader :image, :output_path, :tmp_folder
 
       delegate :vips_image, to: :image
 
@@ -43,19 +43,14 @@ module Assembly
       def create
         create_jp2_checks
 
-        # KDUcompress doesn’t support arbitrary image types,  so we make a temporary tiff
-        @tmp_tiff_path = make_tmp_tiff
+        Dir.mktmpdir('assembly-image', tmp_folder) do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
 
-        jp2_command = jp2_create_command(source_path: tmp_tiff_path, output: output_path)
-        result = `#{jp2_command}`
-        unless $CHILD_STATUS.success?
-          # Clean up any partial result
-          FileUtils.rm_rf(output_path)
-          raise "JP2 creation command failed: #{jp2_command} with result #{result}"
+          # KDUcompress doesn’t support arbitrary image types, so we make a temporary tiff
+          make_tmp_tiff(tmp_tiff_path)
+          make_jp2(tmp_tiff_path)
         end
 
-        File.delete(tmp_tiff_path) unless tmp_tiff_path.nil?
-
         # create output response object, which is an Assembly::Image type object
         Image.new(output_path)
       end
@@ -94,22 +89,22 @@ module Assembly
         'Clevels=5' # Number of wavelet decomposition levels, or stages
       ].freeze
 
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
       def create_jp2_checks
+        raise "tmp_folder #{tmp_folder} does not exist" unless File.exist?(tmp_folder)
+
         image.send(:check_for_file)
         raise 'input file is not a valid image, or is the wrong mimetype' unless image.jp2able?
 
         raise SecurityError, "output #{output_path} exists, cannot overwrite" if !overwrite? && File.exist?(output_path)
         raise SecurityError, 'cannot recreate jp2 over itself' if overwrite? && image.mimetype == 'image/jp2' && output_path == image.path
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       # We do this because we need to reliably compress the tiff and KDUcompress doesn’t support arbitrary image types
-      # rubocop:disable Metrics/MethodLength
-      def make_tmp_tiff
-        raise "tmp_folder #{tmp_folder} does not exist" unless File.exist?(tmp_folder)
-
-        # make temp tiff filename
-        tmp_tiff_file = Tempfile.new(['assembly-image', '.tif'], tmp_folder)
-        result_path = tmp_tiff_file.path
+      def make_tmp_tiff(tmp_tiff_path)
         tmp_tiff_image = if vips_image.interpretation.eql?(:cmyk)
                            vips_image.icc_transform(SRGB_ICC, input_profile: CMYK_ICC)
                          elsif image.has_profile?
@@ -118,10 +113,21 @@ module Assembly
                            vips_image
                          end
 
-        tmp_tiff_image.tiffsave(result_path, bigtiff: true) # Use bigtiff so we can support images > 4GB
-        result_path
+        tmp_tiff_image.tiffsave(tmp_tiff_path, bigtiff: true) # Use bigtiff so we can support images > 4GB
+
+        # For troublshooting JP2 creation problems. See https://github.com/sul-dlss/common-accessioning/issues/1079
+        raise "Temp tiff files #{tmp_tiff_path} does not exist" unless File.exist?(tmp_tiff_path)
+      end
+
+      def make_jp2(tmp_tiff_path)
+        jp2_command = jp2_create_command(source_path: tmp_tiff_path, output: output_path)
+        result = `#{jp2_command}`
+        return if $CHILD_STATUS.success?
+
+        # Clean up any partial result
+        FileUtils.rm_rf(output_path)
+        raise "JP2 creation command failed: #{jp2_command} with result #{result}"
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/spec/assembly/image/jp2_creator_spec.rb

@@ -2,6 +2,7 @@
 
 require 'spec_helper'
 
+# rubocop:disable RSpec/ExampleLength
 RSpec.describe Assembly::Image::Jp2Creator do
   let(:jp2creator) { described_class.new(assembly_image, output: jp2_output_file) }
   let(:assembly_image) { Assembly::Image.new(input_path) }
@@ -52,9 +53,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.path).to eq jp2_output_file
         expect(result.mimetype).to eq 'image/jp2'
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be false
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be false
+        end
       end
     end
 
@@ -87,9 +92,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.path).to eq jp2_output_file
         expect(result.mimetype).to eq 'image/jp2'
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be false
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be false
+        end
       end
     end
 
@@ -113,7 +122,7 @@ RSpec.describe Assembly::Image::Jp2Creator do
         generate_test_image(input_path)
       end
 
-      it 'gets the correct image, creates and cleans up the temporary tiff' do
+      it 'gets the correct image, creates the temporary tiff' do
         expect(File).to exist input_path # test image was generated
         expect(File).not_to exist jp2_output_file
 
@@ -121,12 +130,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.path).to eq jp2_output_file
         expect(result.mimetype).to eq 'image/jp2'
         # check height and width on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.height).to eq 36
-        expect(tmp_tiff_image.width).to eq 43
-
-        expect(jp2creator.tmp_tiff_path).not_to be_nil # temporary tiff was created
-        expect(File).not_to exist jp2creator.tmp_tiff_path # the temporary tiff path is cleaned up
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.height).to eq 36
+          expect(tmp_tiff_image.width).to eq 43
+        end
       end
     end
 
@@ -144,9 +154,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.path).to eq jp2_output_file
         expect(result.mimetype).to eq 'image/jp2'
         # check height and width on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.height).to eq 36
-        expect(tmp_tiff_image.width).to eq 43
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.height).to eq 36
+          expect(tmp_tiff_image.width).to eq 43
+        end
       end
     end
 
@@ -169,9 +183,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
 
         # NOTE: we verify the CMYK has been converted to an SRGB JP2 correctly by using ruby-vips;
         #   we have to verify this on the *temporary tiff because lipvips pkg available for circleci does not speak JP2
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be true
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be true
+        end
       end
     end
 
@@ -189,9 +207,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.path).to eq jp2_output_file
         expect(result.mimetype).to eq 'image/jp2'
         # check height and width on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.height).to eq 36
-        expect(tmp_tiff_image.width).to eq 43
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.height).to eq 36
+          expect(tmp_tiff_image.width).to eq 43
+        end
       end
     end
 
@@ -212,9 +234,13 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.mimetype).to eq 'image/jp2'
 
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be false
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be false
+        end
       end
     end
 
@@ -237,12 +263,16 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.mimetype).to eq 'image/jp2'
 
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be false
-        expect(tmp_tiff_image.has_profile?).to be false
-        vips_for_tmp_tiff = tmp_tiff_image.vips_image
-        expect(vips_for_tmp_tiff.bands).to eq 1
-        expect(vips_for_tmp_tiff.interpretation).to eq :'b-w'
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be false
+          expect(tmp_tiff_image.has_profile?).to be false
+          vips_for_tmp_tiff = tmp_tiff_image.vips_image
+          expect(vips_for_tmp_tiff.bands).to eq 1
+          expect(vips_for_tmp_tiff.interpretation).to eq :'b-w'
+        end
       end
     end
 
@@ -267,10 +297,14 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.mimetype).to eq 'image/jp2'
 
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be false
-        expect(tmp_tiff_image.vips_image.bands).to eq 3
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be false
+          expect(tmp_tiff_image.vips_image.bands).to eq 3
+        end
       end
     end
 
@@ -294,12 +328,16 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.mimetype).to eq 'image/jp2'
 
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be false
-        expect(tmp_tiff_image.has_profile?).to be false
-        vips_for_tmp_tiff = tmp_tiff_image.vips_image
-        expect(vips_for_tmp_tiff.bands).to eq 1
-        expect(vips_for_tmp_tiff.interpretation).to eq :'b-w'
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be false
+          expect(tmp_tiff_image.has_profile?).to be false
+          vips_for_tmp_tiff = tmp_tiff_image.vips_image
+          expect(vips_for_tmp_tiff.bands).to eq 1
+          expect(vips_for_tmp_tiff.interpretation).to eq :'b-w'
+        end
       end
     end
 
@@ -321,27 +359,33 @@ RSpec.describe Assembly::Image::Jp2Creator do
         expect(result.mimetype).to eq 'image/jp2'
 
         # check srgb on temporary tiff (due to CI libvips not speaking jp2)
-        tmp_tiff_image = Assembly::Image.new(jp2creator.send(:make_tmp_tiff))
-        expect(tmp_tiff_image.srgb?).to be true
-        expect(tmp_tiff_image.has_profile?).to be false
-        vips_for_tmp_tiff = tmp_tiff_image.vips_image
-        expect(vips_for_tmp_tiff.bands).to eq 3
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          tmp_tiff_image = Assembly::Image.new(tmp_tiff_path)
+          expect(tmp_tiff_image.srgb?).to be true
+          expect(tmp_tiff_image.has_profile?).to be false
+          vips_for_tmp_tiff = tmp_tiff_image.vips_image
+          expect(vips_for_tmp_tiff.bands).to eq 3
+        end
       end
     end
   end
 
   describe '#make_tmp_tiff' do
-    subject(:tiff_file) { jp2creator.send(:make_tmp_tiff) }
-
     let(:input_path) { 'spec/test_data/color_rgb_srgb_rot90cw.tif' }
-    let(:vips_output) { Vips::Image.new_from_file(tiff_file) }
     let(:plum) { [94.0, 58.0, 101.0] }
 
     context 'when given a tiff with a rotation hint' do
       it 'rotates it' do
         expect(Vips::Image.new_from_file(input_path).getpoint(3, 3)).not_to eq plum
-        expect(vips_output.getpoint(3, 3)).to eq plum
+        Dir.mktmpdir('assembly-image-test') do |tmp_tiff_dir|
+          tmp_tiff_path = File.join(tmp_tiff_dir, 'temp.tif')
+          jp2creator.send(:make_tmp_tiff, tmp_tiff_path)
+          expect(Vips::Image.new_from_file(tmp_tiff_path).getpoint(3, 3)).to eq plum
+        end
       end
     end
   end
 end
+# rubocop:enable RSpec/ExampleLength

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-image
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport