assembly-image 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20363be74017e077bf4a7213ad50605a15a09d1db4c3d13a817a489f9510eaa6
-  data.tar.gz: 3d02e1a8d0bfec9f0cf9d3b61b400f9dd86fa9c858f5210e82e2a6e481ad08c0
+  metadata.gz: 61afd775bdcdf7d49e958964cb581deeaca8755250a9cfe459b7a741037c198a
+  data.tar.gz: 8d0aedfe78807e2965ca0376589e097b2df9b5ca9647659a626e1fbbfb6beb87
 SHA512:
-  metadata.gz: 20a31ca15cc443ab1b0a8b8a82523595c70de654e01863abf6c893771493ad2d5e920733843d3a8b66b6012ed5843f28399a09cfa4ea738c82cf708cc02368ef
-  data.tar.gz: eca98c8800b2d4bcd51a0df2c5a626879b3d43aa67ac65dfe6e1a0298e485505f17819e9a8bf9a4048cc6b45afaa4c4b7b3aa36a31d49acc8c0f02e8d3fb91b6
+  metadata.gz: 465cc5080873a1f079e029925bdfdcd5dd0609afef304cc53190c790608e2805894e3b8f4554a7eac6ed398decc6af077ec19dbfc945e8301d1f2454e026a982
+  data.tar.gz: f4cc63a293fe3f2d80074a697b8618e968d9dc49aa323033e4acf22c4513d92b50e5db5b7d3805c9051f366d007e82f4c14858bcb8b0445c4edf484c17b7298e

data/.rubocop.yml

@@ -26,7 +26,7 @@ Naming/FileName:
   Exclude:
    - lib/assembly-image.rb
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   ForbiddenPrefixes:
     - is_
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    assembly-image (2.1.3)
+    assembly-image (2.2.0)
       activesupport (> 6.1)
       assembly-objectfile (>= 1.6.4)
       ruby-vips (>= 2.0)
@@ -9,7 +9,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (8.1.1)
+    activesupport (8.1.2)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -22,30 +22,37 @@ GEM
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
       uri (>= 0.13.1)
-    assembly-objectfile (2.2.0)
+    assembly-objectfile (2.2.1)
       activesupport (>= 5.2.0)
       mime-types (> 3)
       mini_exiftool
     ast (2.4.3)
     base64 (0.3.0)
     bigdecimal (4.0.1)
-    byebug (12.0.0)
-    coderay (1.1.3)
     concurrent-ruby (1.3.6)
     connection_pool (3.0.2)
+    date (3.5.1)
+    debug (1.11.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
     diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.3)
-    ffi (1.17.2-arm64-darwin)
-    ffi (1.17.2-x86_64-darwin)
-    ffi (1.17.2-x86_64-linux-gnu)
+    erb (6.0.1)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x86_64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
     i18n (1.14.8)
       concurrent-ruby (~> 1.0)
+    io-console (0.8.2)
+    irb (1.16.0)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
     json (2.18.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    method_source (1.1.0)
     mime-types (3.7.0)
       logger
       mime-types-data (~> 3.2025, >= 3.2025.0507)
@@ -60,18 +67,24 @@ GEM
     parser (3.3.10.0)
       ast (~> 2.4.1)
       racc
+    pp (0.6.3)
+      prettyprint
+    prettyprint (0.2.0)
     prism (1.7.0)
-    pry (0.15.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    pry-byebug (3.11.0)
-      byebug (~> 12.0)
-      pry (>= 0.13, < 0.16)
     pstore (0.2.0)
+    psych (5.3.1)
+      date
+      stringio
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.1)
+    rdoc (7.0.3)
+      erb
+      psych (>= 4.0.0)
+      tsort
     regexp_parser (2.11.3)
+    reline (0.6.3)
+      io-console (~> 0.5)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -105,7 +118,7 @@ GEM
     rubocop-factory_bot (2.28.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-rspec (3.8.0)
+    rubocop-rspec (3.9.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.81)
     rubocop-rspec_rails (2.32.0)
@@ -123,6 +136,8 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
+    stringio (3.2.0)
+    tsort (0.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.2.0)
@@ -132,6 +147,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-23
+  arm64-darwin-24
   x86_64-darwin-19
   x86_64-darwin-21
   x86_64-darwin-22
@@ -139,7 +155,7 @@ PLATFORMS
 
 DEPENDENCIES
   assembly-image!
-  pry-byebug
+  debug
   rake
   rspec (~> 3.0)
   rubocop

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.3'
+  s.version     = '2.2.0'
   s.authors     = ['Peter Mangiafico', 'Renzo Sanchez-Silva', 'Monty Hindman', 'Tony Calavano']
   s.email       = ['pmangiafico@stanford.edu']
   s.homepage    = ''
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'assembly-objectfile', '>= 1.6.4'
   s.add_dependency 'ruby-vips', '>= 2.0'
 
-  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'debug'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rubocop'

data/bin/console

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 require 'rubygems'
-require 'irb'
+require 'pry'
 
 require File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
 
-IRB.start
+Pry.start

data/lib/assembly/image.rb

@@ -17,6 +17,26 @@ module Assembly
       vips_image.width
     end
 
+    # @return [boolean] true if this image is a multi-page (e.g. a TIFF with multiple pages)
+    def multi_page?
+      return false unless mimetype == 'image/tiff'
+
+      vips_image.get('n-pages').to_i > 1
+    rescue Vips::Error
+      false
+    end
+
+    # Extract and save only the first page from a multi-image TIFF
+    # @param [String] output_path path to save the extracted first page
+    def extract_first_page(output_path)
+      raise "Cannot extract first page from mimetype #{mimetype}" unless mimetype == 'image/tiff'
+
+      first_page = Vips::Image.new_from_file(path, page: 0).autorot
+      first_page.write_to_file(output_path)
+
+      true
+    end
+
     # @return [string] full default jp2 path and filename that will be created from the given image
     # Example:  given original file of '/dir/path_to_file.tif', gives '/dir/path_to_file.jp2'
     def jp2_filename

data/spec/assembly/image_spec.rb

@@ -22,4 +22,91 @@ RSpec.describe Assembly::Image do
       end
     end
   end
+
+  describe '#multi_page?' do
+    context 'with a single page TIFF' do
+      before { generate_test_image(input_path) }
+
+      it 'returns false' do
+        expect(assembly_image.multi_page?).to be false
+      end
+    end
+
+    context 'with a multi-page TIFF' do
+      let(:input_path) { TEST_MULTIPAGE_TIF_FILE } # this image exists and is in our checked in codebase
+
+      it 'returns true' do
+        expect(assembly_image.multi_page?).to be true
+      end
+    end
+
+    context 'with a non-TIFF image' do
+      before { generate_test_image(input_path) }
+
+      let(:input_path) { TEST_JPEG_INPUT_FILE }
+
+      it 'returns false (JPEG cannot have multiple pages)' do
+        expect(assembly_image.multi_page?).to be false
+      end
+    end
+
+    context 'when Vips raises an error' do
+      before { generate_test_image(input_path) }
+
+      let(:input_path) { TEST_TIF_INPUT_FILE }
+
+      it 'rescues the error and returns false' do
+        allow(assembly_image.vips_image).to receive(:get).and_raise(Vips::Error, 'Test error')
+        expect(assembly_image.multi_page?).to be false
+      end
+    end
+  end
+
+  describe '#extract_first_page' do
+    let(:output_path) { File.join(TEST_OUTPUT_DIR, 'extracted.tif') }
+
+    after { FileUtils.rm_f(output_path) }
+
+    context 'with a single page TIFF' do
+      let(:input_path) { TEST_TIF_INPUT_FILE }
+
+      before { generate_test_image(input_path) }
+
+      it 'extracts and saves the first page' do
+        expect(assembly_image.multi_page?).to be false
+        result = assembly_image.extract_first_page(output_path)
+        expect(result).to be true
+        expect(File.exist?(output_path)).to be true
+        extracted = described_class.new(output_path)
+        expect(extracted.width).to eq assembly_image.width
+        expect(extracted.height).to eq assembly_image.height
+        expect(extracted.multi_page?).to be false
+      end
+    end
+
+    context 'with a multi-page TIFF' do
+      let(:input_path) { TEST_MULTIPAGE_TIF_FILE } # this is a test multi-page image that exists and is in our checked in codebase
+
+      it 'extracts only the first page' do
+        expect(assembly_image.multi_page?).to be true
+        result = assembly_image.extract_first_page(output_path)
+        expect(result).to be true
+        expect(File.exist?(output_path)).to be true
+        extracted = described_class.new(output_path)
+        expect(extracted.width).to eq assembly_image.width
+        expect(extracted.height).to eq assembly_image.height
+        expect(extracted.multi_page?).to be false
+      end
+    end
+
+    context 'with different image formats' do
+      before { generate_test_image(input_path) }
+
+      let(:input_path) { TEST_JPEG_INPUT_FILE }
+
+      it 'raises an error' do
+        expect { assembly_image.extract_first_page(output_path) }.to raise_error(RuntimeError, 'Cannot extract first page from mimetype image/jpeg')
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -13,12 +13,13 @@ end
 
 bootfile = File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
 require bootfile
-require 'pry-byebug'
+require 'debug'
 
 TEST_INPUT_DIR       = File.join(Assembly::PATH_TO_IMAGE_GEM, 'spec', 'test_data', 'input')
 TEST_OUTPUT_DIR      = File.join(Assembly::PATH_TO_IMAGE_GEM, 'spec', 'test_data', 'output')
 TEST_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.tif')
 TEST_JPEG_INPUT_FILE = File.join(TEST_INPUT_DIR, 'test.jpg')
+TEST_MULTIPAGE_TIF_FILE = File.join(Assembly::PATH_TO_IMAGE_GEM, 'spec', 'test_data', 'shapes_multi_size.tif')
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assembly-image
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Peter Mangiafico
@@ -55,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -216,6 +216,7 @@ files:
 - spec/test_data/color_rgb_srgb_rot90cw.tif
 - spec/test_data/input/.empty
 - spec/test_data/output/.empty
+- spec/test_data/shapes_multi_size.tif
 homepage: ''
 licenses: []
 metadata: