assembly-objectfile 1.13.0 → 2.1.1

data/lib/assembly-objectfile.rb

@@ -1,30 +1,25 @@
 # frozen_string_literal: true
 
 module Assembly
-  # the path to the gem, used to access profiles stored with the gem
-  PATH_TO_GEM = File.expand_path("#{File.dirname(__FILE__)}/..")
-
-  # if input image is not one of these mime types, it will not be regarded as a valid image for the purpose of generating a JP2 derivative
+  # If input image is not one of these mime types, it will not be regarded as a valid image
+  # for the purpose of generating a JP2 derivative
   VALID_IMAGE_MIMETYPES = ['image/jpeg', 'image/tiff', 'image/tif', 'image/png'].freeze
 
-  # if input file has one of these extensions in a 3D object, it will get the 3d resource type
-  VALID_THREE_DIMENSION_EXTENTIONS = ['.obj'].freeze
-
-  # the list of mimetypes that will be "trusted" by the unix file command; if a mimetype other than one of these is returned
-  #  by the file command, then a check will be made to see if exif data exists...if so, the mimetype returned by the exif data will be used
-  #  if no exif data exists, then the mimetype returned by the unix file command will be used
-  TRUSTED_MIMETYPES = ['text/plain', 'plain/text', 'application/pdf', 'text/html', 'application/xml'].freeze
+  # The list of mimetypes that will be "trusted" by the unix file command; if a mimetype other than
+  # one of these is returned by the file command, then a check will be made to see if exif data exists...
+  # if so, the mimetype returned by the exif data will be used if no exif data exists, then the
+  # mimetype returned by the unix file command will be used
+  TRUSTED_MIMETYPES = ['text/plain', 'plain/text', 'application/pdf', 'text/html', 'application/xml',
+                       'application/octet-stream'].freeze
 
-  # this is a manual override mapping of file extension to mimetype; if a file with the given extension is found, the mapped
-  #  mimetype will be returned and no further methods will be used - this is used to force a specific mimetype to be returned for
-  #  for a given file extension regardless of what exif or the unix file system command returns
-  #  the mapping format is "extension with period: returned mimetype",  e.g. for any .json file, you will always get `application/json`
+  # This is a manual override mapping of file extension to mimetype; if a file with the given extension
+  # is found, the mapped mimetype will be returned and no further methods will be used - this is used
+  # to force a specific mimetype to be returned for a given file extension regardless of what exif or
+  # the unix file system command returns the mapping format is "extension with period: returned mimetype",
+  # e.g. for any .json file, you will always get `application/json`
   OVERRIDE_MIMETYPES = {
     '.json': 'application/json'
   }.freeze
 end
 
-require 'assembly-objectfile/content_metadata'
-require 'assembly-objectfile/object_fileable'
-require 'assembly-objectfile/object_file'
-require 'assembly-objectfile/version'
+require 'assembly/object_file'

data/spec/assembly/object_file_spec.rb

@@ -0,0 +1,452 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Assembly::ObjectFile do
+  describe '.common_path' do
+    context 'when common path is 2 nodes out of 4' do
+      it 'returns the common directory' do
+        expect(described_class.common_path(['/Users/peter/00/test.tif',
+                                            '/Users/peter/05/test.jp2'])).to eq('/Users/peter/')
+      end
+    end
+
+    context 'when common path is 3 nodes out of 4' do
+      it 'returns the common directory' do
+        expect(described_class.common_path(['/Users/peter/00/test.tif',
+                                            '/Users/peter/00/test.jp2'])).to eq('/Users/peter/00/')
+      end
+    end
+
+    context 'when all in list terminate in diff directories' do
+      it 'returns the common directory' do
+        expect(described_class.common_path(['/Users/peter/00', '/Users/peter/05'])).to eq('/Users/peter/')
+      end
+    end
+  end
+
+  describe '#new' do
+    context 'without params' do
+      let(:object_file) { described_class.new('/some/file.txt') }
+
+      it 'does not set attributes' do
+        expect(object_file.path).to eq('/some/file.txt')
+        expect(object_file.label).to be_nil
+        expect(object_file.file_attributes).to be_nil
+        expect(object_file.provider_sha1).to be_nil
+        expect(object_file.provider_md5).to be_nil
+        expect(object_file.relative_path).to be_nil
+      end
+    end
+
+    context 'with params' do
+      let(:object_file) do
+        described_class.new('/some/file.txt', label: 'some label',
+                                              file_attributes: { 'shelve' => 'yes',
+                                                                 'publish' => 'yes',
+                                                                 'preserve' => 'no' },
+                                              relative_path: '/tmp')
+      end
+
+      it 'sets attributes to passed params' do
+        expect(object_file.path).to eq('/some/file.txt')
+        expect(object_file.label).to eq('some label')
+        expect(object_file.file_attributes).to eq('shelve' => 'yes', 'publish' => 'yes', 'preserve' => 'no')
+        expect(object_file.provider_sha1).to be_nil
+        expect(object_file.provider_md5).to be_nil
+        expect(object_file.relative_path).to eq('/tmp')
+      end
+
+      context 'with provider_md5' do
+        let(:object_file) { described_class.new('/some/file.txt', provider_md5: 'XYZ') }
+
+        it 'sets provider_md5 to passed param' do
+          expect(object_file.provider_md5).to eq('XYZ')
+        end
+      end
+    end
+  end
+
+  describe '#filename' do
+    it 'returns File.basename' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.filename).to eq('test.tif')
+      expect(object_file.filename).to eq(File.basename(TEST_TIF_INPUT_FILE))
+    end
+  end
+
+  describe '#ext' do
+    it 'returns the file extension' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.ext).to eq('.tif')
+    end
+  end
+
+  describe '#dirname' do
+    it 'returns the File.dirname' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.dirname).to eq(File.dirname(TEST_TIF_INPUT_FILE))
+    end
+  end
+
+  describe '#filename_without_ext' do
+    it 'returns filename before extension' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.filename_without_ext).to eq('test')
+    end
+  end
+
+  describe '#image?' do
+    context 'with tiff' do
+      it 'true' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.image?).to be(true)
+      end
+    end
+
+    context 'with jp2' do
+      it 'true' do
+        object_file = described_class.new(TEST_JP2_INPUT_FILE)
+        expect(object_file.image?).to be(true)
+      end
+    end
+
+    context 'with ruby file' do
+      it 'false' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/assembly/object_file_spec.rb')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.image?).to be(false)
+      end
+    end
+
+    context 'with xml' do
+      it 'false' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/test_data/input/file_with_no_exif.xml')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.image?).to be(false)
+      end
+    end
+  end
+
+  describe '#object_type' do
+    context 'with tiff' do
+      it ':image' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.object_type).to eq(:image)
+      end
+    end
+
+    context 'with jp2' do
+      it ':image' do
+        object_file = described_class.new(TEST_JP2_INPUT_FILE)
+        expect(object_file.object_type).to eq(:image)
+      end
+    end
+
+    context 'with ruby file' do
+      it ':text' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/assembly/object_file_spec.rb')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.object_type).to eq(:text)
+      end
+    end
+
+    context 'with xml' do
+      it ':application' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/test_data/input/file_with_no_exif.xml')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.object_type).to eq(:application)
+      end
+    end
+  end
+
+  describe '#valid_image?' do
+    context 'with tiff' do
+      it 'true' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.valid_image?).to be(true)
+      end
+    end
+
+    context 'with tiff resolution 1' do
+      it 'true' do
+        object_file = described_class.new(TEST_RES1_TIF1)
+        expect(object_file.valid_image?).to be(true)
+      end
+    end
+
+    context 'with tiff no color' do
+      it 'true' do
+        object_file = described_class.new(TEST_TIFF_NO_COLOR_FILE)
+        expect(object_file.valid_image?).to be(true)
+      end
+    end
+
+    context 'with jp2' do
+      it 'true' do
+        object_file = described_class.new(TEST_JP2_INPUT_FILE)
+        expect(object_file.valid_image?).to be(true)
+      end
+    end
+
+    context 'with ruby file' do
+      it 'false' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/assembly/object_file_spec.rb')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.valid_image?).to be(false)
+      end
+    end
+
+    context 'with xml' do
+      it 'false' do
+        non_image_file = File.join(PATH_TO_GEM, 'spec/test_data/input/file_with_no_exif.xml')
+        object_file = described_class.new(non_image_file)
+        expect(object_file.valid_image?).to be(false)
+      end
+    end
+  end
+
+  describe '#mimetype' do
+    # rubocop:disable RSpec/RepeatedExampleGroupBody
+    context 'with .txt file' do
+      it 'plain/text' do
+        object_file = described_class.new(TEST_RES1_TEXT)
+        expect(object_file.mimetype).to eq('text/plain')
+      end
+    end
+
+    context 'with .xml file' do
+      it 'plain/text' do
+        object_file = described_class.new(TEST_RES1_TEXT)
+        expect(object_file.mimetype).to eq('text/plain')
+      end
+    end
+    # rubocop:enable RSpec/RepeatedExampleGroupBody
+
+    context 'with .tif file' do
+      it 'image/tiff' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.mimetype).to eq('image/tiff')
+      end
+    end
+
+    context 'with .jp2 file' do
+      it 'image/jp2' do
+        object_file = described_class.new(TEST_JP2_INPUT_FILE)
+        expect(object_file.mimetype).to eq('image/jp2')
+      end
+    end
+
+    context 'with .pdf file' do
+      it 'application/pdf' do
+        object_file = described_class.new(TEST_RES1_PDF)
+        expect(object_file.mimetype).to eq('application/pdf')
+      end
+    end
+
+    context 'with .obj (3d) file' do
+      context 'when default preference (unix file system command)' do
+        it 'plain/text' do
+          object_file = described_class.new(TEST_OBJ_FILE)
+          expect(object_file.mimetype).to eq('text/plain')
+        end
+      end
+
+      context 'when mimetype extension gem preferred over unix file system command' do
+        it 'application/x-tgif' do
+          object_file = described_class.new(TEST_OBJ_FILE, mime_type_order: %i[extension file exif])
+          expect(object_file.mimetype).to eq('application/x-tgif')
+        end
+      end
+
+      context 'when invalid first preference mimetype generation' do
+        it 'ignores invalid mimetype generation method and respects valid method preference order' do
+          object_file = described_class.new(TEST_OBJ_FILE, mime_type_order: %i[bogus extension file])
+          expect(object_file.mimetype).to eq('application/x-tgif')
+        end
+      end
+    end
+
+    context 'with .ply 3d file' do
+      it 'text/plain' do
+        object_file = described_class.new(TEST_PLY_FILE)
+        expect(object_file.mimetype).to eq('text/plain')
+      end
+    end
+
+    context 'when exif information is damaged' do
+      it 'gives us the mimetype' do
+        object_file = described_class.new(TEST_FILE_NO_EXIF)
+        expect(object_file.filename).to eq('file_with_no_exif.xml')
+        expect(object_file.ext).to eq('.xml')
+        # we could get either of these mimetypes depending on the OS
+        expect(['text/html', 'application/xml'].include?(object_file.mimetype)).to be true
+      end
+    end
+
+    context 'when .json file' do
+      it 'uses the manual mapping to set the correct mimetype of application/json for a .json file' do
+        object_file = described_class.new(TEST_JSON_FILE)
+        expect(object_file.send(:exif_mimetype)).to be_nil # exif
+        expect(object_file.send(:file_mimetype)).to eq('text/plain') # unix file system command
+        expect(object_file.mimetype).to eq('application/json') # our configured mapping overrides both
+      end
+    end
+  end
+
+  describe '#file_mimetype (unix file system command)' do
+    context 'when .json file' do
+      it 'text/plain' do
+        object_file = described_class.new(TEST_JSON_FILE)
+        expect(object_file.send(:file_mimetype)).to eq('text/plain')
+      end
+    end
+
+    context 'when .tif file' do
+      it 'image/tiff' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.send(:file_mimetype)).to eq('image/tiff')
+      end
+    end
+  end
+
+  describe '#jp2able?' do
+    context 'with jp2 file' do
+      it 'false' do
+        object_file = described_class.new(TEST_JP2_INPUT_FILE)
+        expect(object_file.jp2able?).to be(false)
+      end
+    end
+
+    context 'with tiff resolution 1 file' do
+      it 'true' do
+        object_file = described_class.new(TEST_RES1_TIF1)
+        expect(object_file.jp2able?).to be(true)
+      end
+    end
+
+    context 'with tiff no color file' do
+      it 'true' do
+        object_file = described_class.new(TEST_TIFF_NO_COLOR_FILE)
+        expect(object_file.jp2able?).to be(true)
+      end
+    end
+  end
+
+  describe '#md5' do
+    it 'computes md5 for an image file' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.md5).to eq('a2400500acf21e43f5440d93be894101')
+    end
+
+    it 'raises RuntimeError if no input file is passed in' do
+      object_file = described_class.new('')
+      expect { object_file.md5 }.to raise_error(RuntimeError, 'input file  does not exist or is a directory')
+    end
+  end
+
+  describe '#sha1' do
+    it 'computes sha1 for an image file' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.sha1).to eq('8d11fab63089a24c8b17063d29a4b0eac359fb41')
+    end
+
+    it 'raises RuntimeError if no input file is passed in' do
+      object_file = described_class.new('')
+      expect { object_file.sha1 }.to raise_error(RuntimeError, 'input file  does not exist or is a directory')
+    end
+  end
+
+  describe '#file_exists?' do
+    it 'false when a valid directory is specified instead of a file' do
+      path = PATH_TO_GEM
+      object_file = described_class.new(path)
+      expect(File.exist?(path)).to be true
+      expect(File.directory?(path)).to be true
+      expect(object_file.file_exists?).to be false
+    end
+
+    it 'false when a non-existent file is specified' do
+      path = File.join(PATH_TO_GEM, 'file_not_there.txt')
+      object_file = described_class.new(path)
+      expect(File.exist?(path)).to be false
+      expect(File.directory?(path)).to be false
+      expect(object_file.file_exists?).to be false
+    end
+  end
+
+  describe '#filesize' do
+    it 'tells us the size of an input file' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.filesize).to eq(63_542)
+    end
+
+    it 'raises RuntimeError if no file is passed in' do
+      object_file = described_class.new('')
+      expect { object_file.filesize }.to raise_error(RuntimeError, 'input file  does not exist or is a directory')
+    end
+  end
+
+  describe '#encoding' do
+    context 'with .tif file' do
+      it 'binary' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.send(:encoding)).to eq('binary')
+      end
+    end
+
+    context 'with .txt file' do
+      it 'binary' do
+        object_file = described_class.new(TEST_RES1_TEXT)
+        expect(object_file.send(:encoding)).to eq('us-ascii')
+      end
+    end
+  end
+
+  describe '#exif' do
+    it 'returns MiniExiftool object' do
+      object_file = described_class.new(TEST_TIF_INPUT_FILE)
+      expect(object_file.exif).not_to be_nil
+      expect(object_file.exif.class).to eq MiniExiftool
+    end
+
+    it 'raises MiniExiftool::Error with file path if exiftool raises one' do
+      object_file = described_class.new('spec/test_data/empty.txt')
+      expect { object_file.exif }.to raise_error(MiniExiftool::Error,
+                                                 "error initializing MiniExiftool for #{object_file.path}")
+    end
+  end
+
+  describe '#extension_mimetype' do
+    # mime-types gem, based on a file extension lookup
+    context 'with .obj file' do
+      it 'application/x-tgif' do
+        object_file = described_class.new(TEST_OBJ_FILE)
+        expect(object_file.send(:extension_mimetype)).to eq('application/x-tgif')
+      end
+    end
+
+    context 'with .tif file' do
+      it 'image/tiff' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.send(:extension_mimetype)).to eq('image/tiff')
+      end
+    end
+  end
+
+  describe '#exif_mimetype' do
+    context 'with .tif file' do
+      it 'image/tiff' do
+        object_file = described_class.new(TEST_TIF_INPUT_FILE)
+        expect(object_file.send(:exif_mimetype)).to eq('image/tiff')
+      end
+    end
+
+    context 'when .json file' do
+      it 'nil' do
+        object_file = described_class.new(TEST_JSON_FILE)
+        expect(object_file.send(:exif_mimetype)).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -4,60 +4,26 @@ require 'simplecov'
 SimpleCov.start
 
 require File.expand_path("#{File.dirname(__FILE__)}/../config/boot")
-require 'byebug'
+require 'pry-byebug'
 
 RSpec.configure do |config|
   config.order = 'random'
 end
 
-TEST_DATA_DIR = File.join(Assembly::PATH_TO_GEM, 'spec', 'test_data')
-TEST_INPUT_DIR       = File.join(TEST_DATA_DIR, 'input')
-TEST_OUTPUT_DIR      = File.join(TEST_DATA_DIR, 'output')
+PATH_TO_GEM = File.expand_path("#{File.dirname(__FILE__)}/..")
+TEST_INPUT_DIR       = File.join(PATH_TO_GEM, 'spec', 'test_data', 'input')
 TEST_TIF_INPUT_FILE  = File.join(TEST_INPUT_DIR, 'test.tif')
-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')
-
-TEST_DPG_TIF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '00', 'oo000oo0001_00_001.tif')
-TEST_DPG_TIF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '00', 'oo000oo0001_00_002.tif')
-TEST_DPG_JP = File.join(TEST_INPUT_DIR, 'oo000oo0001', '05', 'oo000oo0001_05_001.jp2')
-TEST_DPG_JP2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '05', 'oo000oo0001_05_002.jp2')
-TEST_DPG_PDF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '15', 'oo000oo0001_15_001.pdf')
-TEST_DPG_PDF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '15', 'oo000oo0001_15_002.pdf')
-TEST_DPG_SPECIAL_PDF1 = File.join(TEST_INPUT_DIR, 'oo000oo0001', 'oo000oo0001_book.pdf')
-TEST_DPG_SPECIAL_PDF2 = File.join(TEST_INPUT_DIR, 'oo000oo0001', '31', 'oo000oo0001_31_001.pdf')
-TEST_DPG_SPECIAL_TIF = File.join(TEST_INPUT_DIR, 'oo000oo0001', '50', 'oo000oo0001_50_001.tif')
 
 TEST_TIFF_NO_COLOR_FILE = File.join(TEST_INPUT_DIR, 'test_no_color_profile.tif')
 
 TEST_RES1_TIF1 = File.join(TEST_INPUT_DIR, 'res1_image1.tif')
-TEST_RES1_JP1 = File.join(TEST_INPUT_DIR, 'res1_image1.jp2')
-TEST_RES1_TIF2 = File.join(TEST_INPUT_DIR, 'res1_image2.tif')
-TEST_RES1_JP2 = File.join(TEST_INPUT_DIR, 'res1_image2.jp2')
-TEST_RES1_TEI = File.join(TEST_INPUT_DIR, 'res1_teifile.txt')
 TEST_RES1_TEXT = File.join(TEST_INPUT_DIR, 'res1_textfile.txt')
 TEST_RES1_PDF = File.join(TEST_INPUT_DIR, 'res1_transcript.pdf')
 
-TEST_RES2_TIF1 = File.join(TEST_INPUT_DIR, 'res2_image1.tif')
-TEST_RES2_JP1 = File.join(TEST_INPUT_DIR, 'res2_image1.jp2')
-TEST_RES2_TIF2 = File.join(TEST_INPUT_DIR, 'res2_image2.tif')
-TEST_RES2_JP2 = File.join(TEST_INPUT_DIR, 'res2_image2.jp2')
-TEST_RES2_TEI = File.join(TEST_INPUT_DIR, 'res2_teifile.txt')
-TEST_RES2_TEXT = File.join(TEST_INPUT_DIR, 'res2_textfile.txt')
-
-TEST_RES3_TIF1 = File.join(TEST_INPUT_DIR, 'res3_image1.tif')
-TEST_RES3_JP1 = File.join(TEST_INPUT_DIR, 'res3_image1.jp2')
-TEST_RES3_TEI = File.join(TEST_INPUT_DIR, 'res3_teifile.txt')
-
 TEST_FILE_NO_EXIF = File.join(TEST_INPUT_DIR, 'file_with_no_exif.xml')
 
 TEST_JSON_FILE = File.join(TEST_INPUT_DIR, 'test.json')
 
 TEST_OBJ_FILE = File.join(TEST_INPUT_DIR, 'someobject.obj')
 TEST_PLY_FILE = File.join(TEST_INPUT_DIR, 'someobject.ply')
-
-TEST_DRUID = 'nx288wh8889'