assembly-objectfile 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f0c15e9e8be693ac604d4f4f440a62b8c91d4e10e1605d78ecf487b45aa231b
-  data.tar.gz: 1441b9f02785c6397cfee954382b4b0de92e006457b0a5bfce42111b4f1ee634
+  metadata.gz: e964d66148904c190829abd7d9c65d09459405f184a48a2350602d1f4c6b6a5f
+  data.tar.gz: 85fca1341b29f0c3f5b3858b419e0273754de1a47140b5ae36d2cbf2a77feea4
 SHA512:
-  metadata.gz: b12637ddf0e5110ada401dfd04f35072a42046c02fabd1446139f5c387f31bf82fb82ff6b95621f1f182f839ad50b2f66f529ddff61c79979a0c248659dd7947
-  data.tar.gz: f2bf8dcce09af5ac5f499ffff3abafd8ef01b03a30ceb249a590da75b594fd96dcd8a0e73b295ff37ca52825941c5b2892ed05c1746a9de5d85e048138f7e67b
+  metadata.gz: f2cf693279f7c43392f92b3dd8bf28df4baca673276c3c96208b420c6ec26415b37b9498149a0ee6fe8ff4606046768582107f1e71b66199f04463b8f5dec918
+  data.tar.gz: fcdc3f9041410416893e8ba1258c677a9eb0f6ede6eb833deb74f9dcb30e005d226d4486419a6fc2a1ae24b9e0ceda579e1acb7f189cf022af822fc32e275fa6

data/.github/pull_request_template.md

@@ -1,12 +1,10 @@
-## Why was this change made?
+## Why was this change made? 🤔
 
 
 
-## How was this change tested?
+## How was this change tested? 🤨
 
-
-
-## Which documentation and/or configurations were updated?
+⚡ ⚠ If this change has cross service impact, ***run [integration tests](https://github.com/sul-dlss/infrastructure-integration-test) that do accessioning*** and/or test in [stage|qa] environment, in addition to specs. ⚡
 
 
 

data/Gemfile

@@ -4,3 +4,5 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in .gemspec
 gemspec
+
+gem 'byebug'

data/lib/assembly-objectfile/content_metadata/file.rb

@@ -35,7 +35,7 @@ module Assembly
         @style = style
       end
 
-      delegate :sha1, :md5, :provider_md5, :provider_sha1, :mimetype, :filesize, :image?, to: :file
+      delegate :sha1, :md5, :provider_md5, :provider_sha1, :mimetype, :filesize, :image?, :valid_image?, to: :file
 
       def file_id(common_path:, flatten_folder_structure:)
         # set file id attribute, first check the relative_path parameter on the object, and if it is set, just use that

data/lib/assembly-objectfile/content_metadata/nokogiri_builder.rb

@@ -31,19 +31,19 @@ module Assembly
                 resource_label = fileset.label_from_file(default: default_label)
 
                 xml.label(resource_label) unless resource_label.empty?
-                fileset.files.each do |obj| # iterate over all the files in a resource
-                  xml_file_params = { id: obj.file_id(common_path: common_path, flatten_folder_structure: config.flatten_folder_structure) }
-                  xml_file_params.merge!(obj.file_attributes(config.file_attributes)) if config.add_file_attributes
-                  xml_file_params.merge!(mimetype: obj.mimetype, size: obj.filesize) if config.add_exif
+                fileset.files.each do |cm_file| # iterate over all the files in a resource
+                  xml_file_params = { id: cm_file.file_id(common_path: common_path, flatten_folder_structure: config.flatten_folder_structure) }
+                  xml_file_params.merge!(cm_file.file_attributes(config.file_attributes)) if config.add_file_attributes
+                  xml_file_params.merge!(mimetype: cm_file.mimetype, size: cm_file.filesize) if config.add_exif
 
                   xml.file(xml_file_params) do
                     if config.add_exif # add exif info if the user requested it
-                      xml.checksum(obj.sha1, type: 'sha1')
-                      xml.checksum(obj.md5, type: 'md5')
-                      xml.imageData(obj.image_data) if obj.image? # add image data for an image
-                    elsif obj.provider_md5 || obj.provider_sha1 # if we did not add exif info, see if there are user supplied checksums to add
-                      xml.checksum(obj.provider_sha1, type: 'sha1') if obj.provider_sha1
-                      xml.checksum(obj.provider_md5, type: 'md5') if obj.provider_md5
+                      xml.checksum(cm_file.sha1, type: 'sha1')
+                      xml.checksum(cm_file.md5, type: 'md5')
+                      xml.imageData(cm_file.image_data) if cm_file.valid_image? # add image data for an image
+                    elsif cm_file.provider_md5 || cm_file.provider_sha1 # if we did not add exif info, see if there are user supplied checksums to add
+                      xml.checksum(cm_file.provider_sha1, type: 'sha1') if cm_file.provider_sha1
+                      xml.checksum(cm_file.provider_md5, type: 'md5') if cm_file.provider_md5
                     end
                   end
                 end

data/lib/assembly-objectfile/version.rb

@@ -4,6 +4,6 @@
 module Assembly
   class ObjectFile
     # Project version number
-    VERSION = '1.11.0'
+    VERSION = '1.12.0'
   end
 end

data/spec/content_metadata_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Assembly::ContentMetadata do
     let(:xml) { Nokogiri::XML(result) }
 
     context 'when style=simple_image' do
-      context 'when using a single tif and jp2' do
+      context 'when using a single tif and jp2 with add_exif: true' do
         it 'generates valid content metadata with exif, adding file attributes' do
           objects = [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE), Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE)]
           result = described_class.create_content_metadata(druid: TEST_DRUID, add_exif: true, add_file_attributes: true, objects: objects)
@@ -44,46 +44,8 @@ RSpec.describe Assembly::ContentMetadata do
           expect(xml.xpath('//resource/file/imageData')[1].attributes['width'].value).to eq('100')
           expect(xml.xpath('//resource/file/imageData')[1].attributes['height'].value).to eq('100')
         end
-      end
 
-      context 'when using a single tif and jp2' do
-        it 'generates valid content metadata with no exif adding specific file attributes for 2 objects, and defaults for 1 object' do
-          obj1 = Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE)
-          obj2 = Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE)
-          obj3 = Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE2)
-          obj1.file_attributes = { publish: 'no', preserve: 'no', shelve: 'no' }
-          obj2.file_attributes = { publish: 'yes', preserve: 'yes', shelve: 'yes' }
-          objects = [obj1, obj2, obj3]
-          result = described_class.create_content_metadata(druid: TEST_DRUID, add_exif: false, add_file_attributes: true, objects: objects)
-          expect(result.class).to be String
-          xml = Nokogiri::XML(result)
-          expect(xml.errors.size).to eq 0
-          expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('image')
-          expect(xml.xpath('//resource').length).to eq 3
-          expect(xml.xpath('//resource/file').length).to eq 3
-          expect(xml.xpath('//resource/file/checksum').length).to eq 0
-          expect(xml.xpath('//resource/file/imageData').length).to eq 0
-          expect(xml.xpath('//label').length).to eq 3
-          expect(xml.xpath('//label')[0].text).to match(/Image 1/)
-          expect(xml.xpath('//label')[1].text).to match(/Image 2/)
-          expect(xml.xpath('//label')[2].text).to match(/Image 3/)
-          expect(xml.xpath('//resource')[0].attributes['type'].value).to eq('image')
-          expect(xml.xpath('//resource')[1].attributes['type'].value).to eq('image')
-          expect(xml.xpath('//resource')[2].attributes['type'].value).to eq('image')
-          expect(xml.xpath('//resource/file')[0].attributes['publish'].value).to eq('no') # specificially set in object
-          expect(xml.xpath('//resource/file')[0].attributes['preserve'].value).to eq('no') # specificially set in object
-          expect(xml.xpath('//resource/file')[0].attributes['shelve'].value).to eq('no') # specificially set in object
-          expect(xml.xpath('//resource/file')[1].attributes['publish'].value).to eq('yes') # specificially set in object
-          expect(xml.xpath('//resource/file')[1].attributes['preserve'].value).to eq('yes') # specificially set in object
-          expect(xml.xpath('//resource/file')[1].attributes['shelve'].value).to eq('yes')  # specificially set in object
-          expect(xml.xpath('//resource/file')[2].attributes['publish'].value).to eq('yes') # defaults by mimetype
-          expect(xml.xpath('//resource/file')[2].attributes['preserve'].value).to eq('no') # defaults by mimetype
-          expect(xml.xpath('//resource/file')[2].attributes['shelve'].value).to eq('yes') # defaults by mimetype
-        end
-      end
-
-      context 'when using a single tif and jp2' do
-        it 'generates valid content metadata with exif, overriding file labels' do
+        it 'generates valid content metadata, overriding file labels' do
           objects = [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE, label: 'Sample tif label!'), Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE, label: 'Sample jp2 label!')]
           result = described_class.create_content_metadata(druid: TEST_DRUID, add_exif: true, add_file_attributes: true, objects: objects)
           expect(result.class).to be String
@@ -119,6 +81,42 @@ RSpec.describe Assembly::ContentMetadata do
         end
       end
 
+      context 'when using a single tif and jp2 with add_exif: false' do
+        it 'generates valid content metadata adding specific file attributes for 2 objects, and defaults for 1 object' do
+          obj1 = Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE)
+          obj2 = Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE)
+          obj3 = Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE2)
+          obj1.file_attributes = { publish: 'no', preserve: 'no', shelve: 'no' }
+          obj2.file_attributes = { publish: 'yes', preserve: 'yes', shelve: 'yes' }
+          objects = [obj1, obj2, obj3]
+          result = described_class.create_content_metadata(druid: TEST_DRUID, add_exif: false, add_file_attributes: true, objects: objects)
+          expect(result.class).to be String
+          xml = Nokogiri::XML(result)
+          expect(xml.errors.size).to eq 0
+          expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('image')
+          expect(xml.xpath('//resource').length).to eq 3
+          expect(xml.xpath('//resource/file').length).to eq 3
+          expect(xml.xpath('//resource/file/checksum').length).to eq 0
+          expect(xml.xpath('//resource/file/imageData').length).to eq 0
+          expect(xml.xpath('//label').length).to eq 3
+          expect(xml.xpath('//label')[0].text).to match(/Image 1/)
+          expect(xml.xpath('//label')[1].text).to match(/Image 2/)
+          expect(xml.xpath('//label')[2].text).to match(/Image 3/)
+          expect(xml.xpath('//resource')[0].attributes['type'].value).to eq('image')
+          expect(xml.xpath('//resource')[1].attributes['type'].value).to eq('image')
+          expect(xml.xpath('//resource')[2].attributes['type'].value).to eq('image')
+          expect(xml.xpath('//resource/file')[0].attributes['publish'].value).to eq('no') # specificially set in object
+          expect(xml.xpath('//resource/file')[0].attributes['preserve'].value).to eq('no') # specificially set in object
+          expect(xml.xpath('//resource/file')[0].attributes['shelve'].value).to eq('no') # specificially set in object
+          expect(xml.xpath('//resource/file')[1].attributes['publish'].value).to eq('yes') # specificially set in object
+          expect(xml.xpath('//resource/file')[1].attributes['preserve'].value).to eq('yes') # specificially set in object
+          expect(xml.xpath('//resource/file')[1].attributes['shelve'].value).to eq('yes')  # specificially set in object
+          expect(xml.xpath('//resource/file')[2].attributes['publish'].value).to eq('yes') # defaults by mimetype
+          expect(xml.xpath('//resource/file')[2].attributes['preserve'].value).to eq('no') # defaults by mimetype
+          expect(xml.xpath('//resource/file')[2].attributes['shelve'].value).to eq('yes') # defaults by mimetype
+        end
+      end
+
       context 'when using a single tif and jp2' do
         it 'generates valid content metadata with exif, overriding file labels for one, and skipping auto labels for the others or for where the label is set but is blank' do
           objects = [Assembly::ObjectFile.new(TEST_TIF_INPUT_FILE, label: 'Sample tif label!'), Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE), Assembly::ObjectFile.new(TEST_JP2_INPUT_FILE, label: '')]
@@ -331,6 +329,26 @@ RSpec.describe Assembly::ContentMetadata do
           end
         end
       end
+
+      context 'when using a single svg with add_exif: true' do
+        subject(:result) { described_class.create_content_metadata(druid: TEST_DRUID, add_exif: true, auto_labels: false, add_file_attributes: true, objects: objects) }
+
+        let(:objects) { [Assembly::ObjectFile.new(TEST_SVG_INPUT_FILE)] }
+
+        it 'generates no imageData node' do
+          xml = Nokogiri::XML(result)
+          expect(xml.errors.size).to eq 0
+          expect(xml.xpath('//contentMetadata')[0].attributes['type'].value).to eq('image')
+          expect(xml.xpath('//resource/file').length).to eq 1
+          expect(xml.xpath('//resource/file')[0]['mimetype']).to eq 'image/svg+xml'
+          expect(xml.xpath('//resource/file')[0]['publish']).to eq('no')
+          expect(xml.xpath('//resource/file')[0]['preserve']).to eq('yes')
+          expect(xml.xpath('//resource/file')[0]['shelve']).to eq('no')
+          expect(xml.xpath("//resource[@sequence='1']/file").length).to eq 1
+          expect(xml.xpath('//imageData')).not_to be_present
+          expect(xml.xpath('//resource')[0].attributes['type'].value).to eq('image')
+        end
+      end
     end
 
     context 'when style=webarchive-seed' do

data/spec/spec_helper.rb

@@ -3,8 +3,8 @@
 require 'simplecov'
 SimpleCov.start
 
-bootfile = File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
-require bootfile
+require File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
+require 'byebug'
 
 RSpec.configure do |config|
   config.order = 'random'
@@ -18,6 +18,7 @@ TEST_TIF_INPUT_FILE2  = File.join(TEST_INPUT_DIR, 'test2.tif')
 TEST_JPEG_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.jpg')
 TEST_JP2_INPUT_FILE = File.join(TEST_INPUT_DIR, 'test.jp2')
 TEST_JP2_INPUT_FILE2 = File.join(TEST_INPUT_DIR, 'test2.jp2')
+TEST_SVG_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.svg')
 TEST_JP2_OUTPUT_FILE = File.join(TEST_OUTPUT_DIR, 'test.jp2')
 TEST_PDF_FILE = File.join(TEST_INPUT_DIR, 'test.pdf')
 

data/spec/test_data/input/test.svg

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="507.3" height="508.2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" overflow="hidden"><defs><clipPath id="clip0"><rect x="2361" y="213" width="507" height="508"/></clipPath></defs><g clip-path="url(#clip0)" transform="translate(-2361 -213)"><path d="M2361 467C2361 326.72 2474.5 213 2614.5 213 2754.5 213 2868 326.72 2868 467 2868 607.28 2754.5 721 2614.5 721 2474.5 721 2361 607.28 2361 467Z" fill="#BF9000" fill-rule="evenodd"/></g></svg>

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: assembly-objectfile
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Peter Mangiafico
 - Renzo Sanchez-Silva
 - Monty Hindman
 - Tony Calavano
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -265,6 +265,7 @@ files:
 - spec/test_data/input/test.jp2
 - spec/test_data/input/test.json
 - spec/test_data/input/test.pdf
+- spec/test_data/input/test.svg
 - spec/test_data/input/test.tif
 - spec/test_data/input/test2.jp2
 - spec/test_data/input/test2.tif
@@ -273,7 +274,7 @@ homepage: https://github.com/sul-dlss/assembly-objectfile
 licenses:
 - ALv2
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +292,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Ruby immplementation of file services needed to prepare objects to be accessioned
   in SULAIR digital library
@@ -332,6 +333,7 @@ test_files:
 - spec/test_data/input/test.jp2
 - spec/test_data/input/test.json
 - spec/test_data/input/test.pdf
+- spec/test_data/input/test.svg
 - spec/test_data/input/test.tif
 - spec/test_data/input/test2.jp2
 - spec/test_data/input/test2.tif